caracal_the_curve 1.4.1

data/lib/caracal/renderers/fonts_renderer.rb

@@ -0,0 +1,56 @@
+require 'nokogiri'
+
+require 'caracal/renderers/xml_renderer'
+
+
+module Caracal
+  module Renderers
+    class FontsRenderer < XmlRenderer
+      
+      #-------------------------------------------------------------
+      # Public Methods
+      #-------------------------------------------------------------
+      
+      # This method produces the xml required for the `word/fontTable.xml` 
+      # sub-document.
+      #
+      def to_xml
+        builder = ::Nokogiri::XML::Builder.with(declaration_xml) do |xml|
+          xml['w'].fonts root_options do
+            document.fonts.each do |font|
+              xml['w'].font({ 'w:name' => font.font_name })
+            end
+          end
+        end
+        builder.to_xml(save_options)
+      end
+      
+      
+      #-------------------------------------------------------------
+      # Private Methods
+      #------------------------------------------------------------- 
+      private
+      
+      def root_options
+        {
+          'xmlns:mc'  => 'http://schemas.openxmlformats.org/markup-compatibility/2006',
+          'xmlns:o'   => 'urn:schemas-microsoft-com:office:office',
+          'xmlns:r'   => 'http://schemas.openxmlformats.org/officeDocument/2006/relationships',
+          'xmlns:m'   => 'http://schemas.openxmlformats.org/officeDocument/2006/math',
+          'xmlns:v'   => 'urn:schemas-microsoft-com:vml',
+          'xmlns:wp'  => 'http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing',
+          'xmlns:w10' => 'urn:schemas-microsoft-com:office:word',
+          'xmlns:w'   => 'http://schemas.openxmlformats.org/wordprocessingml/2006/main',
+          'xmlns:wne' => 'http://schemas.microsoft.com/office/word/2006/wordml',
+          'xmlns:sl'  => 'http://schemas.openxmlformats.org/schemaLibrary/2006/main',
+          'xmlns:a'   => 'http://schemas.openxmlformats.org/drawingml/2006/main',
+          'xmlns:pic' => 'http://schemas.openxmlformats.org/drawingml/2006/picture',
+          'xmlns:c'   => 'http://schemas.openxmlformats.org/drawingml/2006/chart',
+          'xmlns:lc'  => 'http://schemas.openxmlformats.org/drawingml/2006/lockedCanvas',
+          'xmlns:dgm' => 'http://schemas.openxmlformats.org/drawingml/2006/diagram'
+        }
+      end
+   
+    end
+  end
+end

data/lib/caracal/renderers/footer_renderer.rb

@@ -0,0 +1,90 @@
+require 'nokogiri'
+
+require 'caracal/renderers/xml_renderer'
+
+
+module Caracal
+  module Renderers
+    class FooterRenderer < XmlRenderer
+
+      #-------------------------------------------------------------
+      # Public Methods
+      #-------------------------------------------------------------
+
+      # This method produces the xml required for the `word/settings.xml`
+      # sub-document.
+      #
+      def to_xml
+        builder = ::Nokogiri::XML::Builder.with(declaration_xml) do |xml|
+          xml['w'].ftr root_options do
+            xml['w'].p paragraph_options do
+              xml['w'].pPr do
+                xml['w'].contextualSpacing({ 'w:val' => '0' })
+                xml['w'].jc({ 'w:val' => "#{ document.page_number_align }" })
+              end
+              unless document.page_number_label.nil?
+                xml['w'].r run_options do
+                  xml['w'].rPr do
+                    xml['w'].rStyle({ 'w:val' => 'PageNumber' })
+                    unless document.page_number_label_size.nil?
+                      xml['w'].sz({ 'w:val'  => document.page_number_label_size })
+                    end
+                  end
+                  xml['w'].t({ 'xml:space' => 'preserve' }) do
+                    xml.text "#{ document.page_number_label } "
+                  end
+                end
+              end
+              xml['w'].r run_options do
+                xml['w'].rPr do
+                  unless document.page_number_number_size.nil?
+                    xml['w'].sz({ 'w:val'  => document.page_number_number_size })
+                    xml['w'].szCs({ 'w:val' => document.page_number_number_size })
+                  end
+                end
+                xml['w'].fldChar({ 'w:fldCharType' => 'begin' })
+                xml['w'].instrText({ 'xml:space' => 'preserve' }) do
+                  xml.text 'PAGE'
+                end
+                xml['w'].fldChar({ 'w:fldCharType' => 'end' })
+              end
+              xml['w'].r run_options do
+                xml['w'].rPr do
+                  xml['w'].rtl({ 'w:val' => '0' })
+                end
+              end
+            end
+          end
+        end
+        builder.to_xml(save_options)
+      end
+
+
+      #-------------------------------------------------------------
+      # Private Methods
+      #-------------------------------------------------------------
+      private
+
+      def root_options
+        {
+          'xmlns:mc'  => 'http://schemas.openxmlformats.org/markup-compatibility/2006',
+          'xmlns:o'   => 'urn:schemas-microsoft-com:office:office',
+          'xmlns:r'   => 'http://schemas.openxmlformats.org/officeDocument/2006/relationships',
+          'xmlns:m'   => 'http://schemas.openxmlformats.org/officeDocument/2006/math',
+          'xmlns:v'   => 'urn:schemas-microsoft-com:vml',
+          'xmlns:wp'  => 'http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing',
+          'xmlns:w10' => 'urn:schemas-microsoft-com:office:word',
+          'xmlns:w'   => 'http://schemas.openxmlformats.org/wordprocessingml/2006/main',
+          'xmlns:wne' => 'http://schemas.microsoft.com/office/word/2006/wordml',
+          'xmlns:sl'  => 'http://schemas.openxmlformats.org/schemaLibrary/2006/main',
+          'xmlns:a'   => 'http://schemas.openxmlformats.org/drawingml/2006/main',
+          'xmlns:pic' => 'http://schemas.openxmlformats.org/drawingml/2006/picture',
+          'xmlns:c'   => 'http://schemas.openxmlformats.org/drawingml/2006/chart',
+          'xmlns:lc'  => 'http://schemas.openxmlformats.org/drawingml/2006/lockedCanvas',
+          'xmlns:dgm' => 'http://schemas.openxmlformats.org/drawingml/2006/diagram'
+        }
+      end
+
+    end
+  end
+end

data/lib/caracal/renderers/numbering_renderer.rb

@@ -0,0 +1,88 @@
+require 'nokogiri'
+
+require 'caracal/core/models/list_style_model'
+require 'caracal/core/models/list_model'
+require 'caracal/renderers/xml_renderer'
+
+
+module Caracal
+  module Renderers
+    class NumberingRenderer < XmlRenderer
+
+      #-------------------------------------------------------------
+      # Public Methods
+      #-------------------------------------------------------------
+
+      # This method produces the xml required for the `word/numbering.xml`
+      # sub-document.
+      #
+      def to_xml
+        builder = ::Nokogiri::XML::Builder.with(declaration_xml) do |xml|
+          xml['w'].numbering root_options do
+            
+            # add abstract definitions
+            document.toplevel_lists.each_with_index do |model, i|
+              xml['w'].abstractNum({ 'w:abstractNumId' => i + 1 }) do
+                xml['w'].multiLevelType({ 'w:val' => 'hybridMultilevel' })
+                model.level_map.each do |(level, type)|
+                  if s = document.find_list_style(type, level)
+                    xml['w'].lvl({ 'w:ilvl' => s.style_level }) do
+                      xml['w'].start({ 'w:val' => s.style_start })
+                      xml['w'].numFmt({ 'w:val' => s.style_format })
+                      xml['w'].lvlRestart({ 'w:val' => s.style_restart })
+                      xml['w'].lvlText({ 'w:val' => s.style_value })
+                      xml['w'].lvlJc({ 'w:val' => s.style_align })
+                      xml['w'].pPr do
+                        xml['w'].ind({ 'w:left' => s.style_left, 'w:firstLine' => s.style_indent })
+                      end
+                      xml['w'].rPr do
+                        xml['w'].u({ 'w:val' => 'none' })
+                      end
+                    end
+                  end
+                end
+              end
+            end
+
+            # bind individual tables to abstract definitions
+            document.toplevel_lists.each_with_index do |model, i|
+              xml['w'].num({ 'w:numId' => i + 1 }) do
+                xml['w'].abstractNumId({ 'w:val' => i + 1 })
+              end
+            end
+          end
+
+        end
+        builder.to_xml(save_options)
+      end
+
+
+
+      #-------------------------------------------------------------
+      # Private Methods
+      #-------------------------------------------------------------
+      private
+
+      def root_options
+        {
+          'xmlns:mc'  => 'http://schemas.openxmlformats.org/markup-compatibility/2006',
+          'xmlns:o'   => 'urn:schemas-microsoft-com:office:office',
+          'xmlns:r'   => 'http://schemas.openxmlformats.org/officeDocument/2006/relationships',
+          'xmlns:m'   => 'http://schemas.openxmlformats.org/officeDocument/2006/math',
+          'xmlns:v'   => 'urn:schemas-microsoft-com:vml',
+          'xmlns:wp'  => 'http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing',
+          'xmlns:w10' => 'urn:schemas-microsoft-com:office:word',
+          'xmlns:w'   => 'http://schemas.openxmlformats.org/wordprocessingml/2006/main',
+          'xmlns:wne' => 'http://schemas.microsoft.com/office/word/2006/wordml',
+          'xmlns:sl'  => 'http://schemas.openxmlformats.org/schemaLibrary/2006/main',
+          'xmlns:a'   => 'http://schemas.openxmlformats.org/drawingml/2006/main',
+          'xmlns:pic' => 'http://schemas.openxmlformats.org/drawingml/2006/picture',
+          'xmlns:c'   => 'http://schemas.openxmlformats.org/drawingml/2006/chart',
+          'xmlns:lc'  => 'http://schemas.openxmlformats.org/drawingml/2006/lockedCanvas',
+          'xmlns:dgm' => 'http://schemas.openxmlformats.org/drawingml/2006/diagram'
+        }
+      end
+
+    end
+  end
+end

data/lib/caracal/renderers/package_relationships_renderer.rb

@@ -0,0 +1,51 @@
+require 'nokogiri'
+
+require 'caracal/renderers/xml_renderer'
+
+
+module Caracal
+  module Renderers
+    class PackageRelationshipsRenderer < XmlRenderer
+
+      #-------------------------------------------------------------
+      # Public Methods
+      #-------------------------------------------------------------
+
+      # This method produces the xml required for the `word/settings.xml`
+      # sub-document.
+      #
+      def to_xml
+        builder = ::Nokogiri::XML::Builder.with(declaration_xml) do |xml|
+          xml.send 'Relationships', root_options do
+            relationship_data.each_with_index do |rel, index|
+              xml.send 'Relationship', { 'Target' => rel.first, 'Type' => rel.last, 'Id' => "rId#{ index + 1 }" }
+            end
+          end
+        end
+        builder.to_xml(save_options)
+      end
+
+
+      #-------------------------------------------------------------
+      # Private Methods
+      #-------------------------------------------------------------
+      private
+
+      def relationship_data
+        [
+          ['docProps/app.xml',    'http://schemas.openxmlformats.org/officeDocument/2006/relationships/extended-properties'],
+          ['docProps/core.xml',   'http://schemas.openxmlformats.org/package/2006/relationships/metadata/core-properties'],
+          ['docProps/custom.xml', 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/custom-properties'],
+          ['word/document.xml',   'http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument']
+        ]
+      end
+
+      def root_options
+        {
+          'xmlns' => 'http://schemas.openxmlformats.org/package/2006/relationships'
+        }
+      end
+
+    end
+  end
+end

data/lib/caracal/renderers/relationships_renderer.rb

@@ -0,0 +1,48 @@
+require 'nokogiri'
+
+require 'caracal/renderers/xml_renderer'
+
+
+module Caracal
+  module Renderers
+    class RelationshipsRenderer < XmlRenderer
+      
+      #-------------------------------------------------------------
+      # Public Methods
+      #-------------------------------------------------------------
+      
+      # This method produces the xml required for the `word/settings.xml` 
+      # sub-document.
+      #
+      def to_xml
+        builder = ::Nokogiri::XML::Builder.with(declaration_xml) do |xml|
+          xml.send 'Relationships', root_options do
+            document.relationships.each do |rel|
+              xml.send 'Relationship', rel_options(rel)
+            end
+          end
+        end
+        builder.to_xml(save_options)
+      end
+      
+      
+      #-------------------------------------------------------------
+      # Private Methods
+      #------------------------------------------------------------- 
+      private
+      
+      def rel_options(rel)
+        opts = { 'Target' => rel.formatted_target, 'Type' => rel.formatted_type, 'Id' => rel.formatted_id}
+        opts['TargetMode'] = 'External' if rel.target_mode?
+        opts
+      end
+      
+      def root_options
+        {
+          'xmlns' => 'http://schemas.openxmlformats.org/package/2006/relationships'
+        }
+      end
+   
+    end
+  end
+end

data/lib/caracal/renderers/settings_renderer.rb

@@ -0,0 +1,58 @@
+require 'nokogiri'
+
+require 'caracal/renderers/xml_renderer'
+
+
+module Caracal
+  module Renderers
+    class SettingsRenderer < XmlRenderer
+      
+      #-------------------------------------------------------------
+      # Public Methods
+      #-------------------------------------------------------------
+      
+      # This method produces the xml required for the `word/settings.xml` 
+      # sub-document.
+      #
+      def to_xml
+        builder = ::Nokogiri::XML::Builder.with(declaration_xml) do |xml|
+          xml['w'].settings root_options do
+            xml['w'].displayBackgroundShape({ 'w:val' => '1' })
+            xml['w'].defaultTabStop({ 'w:val' => '720' })
+            xml['w'].compat do
+              xml['w'].compatSetting({ 'w:val' => '14', 'w:name' => 'compatibilityMode', 'w:uri' => 'http://schemas.microsoft.com/office/word' })
+            end
+          end
+        end
+        builder.to_xml(save_options)
+      end
+      
+      
+      #-------------------------------------------------------------
+      # Private Methods
+      #------------------------------------------------------------- 
+      private
+      
+      def root_options
+        {
+          'xmlns:mc'   => 'http://schemas.openxmlformats.org/markup-compatibility/2006',
+          'xmlns:o'    => 'urn:schemas-microsoft-com:office:office',
+          'xmlns:r'    => 'http://schemas.openxmlformats.org/officeDocument/2006/relationships',
+          'xmlns:m'    => 'http://schemas.openxmlformats.org/officeDocument/2006/math',
+          'xmlns:v'    => 'urn:schemas-microsoft-com:vml',
+          'xmlns:wp'   => 'http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing',
+          'xmlns:w10'  => 'urn:schemas-microsoft-com:office:word',
+          'xmlns:w'    => 'http://schemas.openxmlformats.org/wordprocessingml/2006/main',
+          'xmlns:wne'  => 'http://schemas.microsoft.com/office/word/2006/wordml',
+          'xmlns:sl'   => 'http://schemas.openxmlformats.org/schemaLibrary/2006/main',
+          'xmlns:a'    => 'http://schemas.openxmlformats.org/drawingml/2006/main',
+          'xmlns:pic'  => 'http://schemas.openxmlformats.org/drawingml/2006/picture',
+          'xmlns:c'    => 'http://schemas.openxmlformats.org/drawingml/2006/chart',
+          'xmlns:lc'   => 'http://schemas.openxmlformats.org/drawingml/2006/lockedCanvas',
+          'xmlns:dgm'  => 'http://schemas.openxmlformats.org/drawingml/2006/diagram'
+        }
+      end
+   
+    end
+  end
+end

data/lib/caracal/renderers/styles_renderer.rb

@@ -0,0 +1,181 @@
+require 'nokogiri'
+
+require 'caracal/renderers/xml_renderer'
+require 'caracal/errors'
+
+
+module Caracal
+  module Renderers
+    class StylesRenderer < XmlRenderer
+
+      #----------------------------------------------------
+      # Public Methods
+      #----------------------------------------------------
+
+      # This method produces the xml required for the `word/styles.xml`
+      # sub-document.
+      #
+      def to_xml
+        builder = ::Nokogiri::XML::Builder.with(declaration_xml) do |xml|
+          xml['w'].styles root_options do
+
+            #========== DEFAULT STYLES ====================
+
+            unless s = document.default_style
+              raise Caracal::Errors::NoDefaultStyleError 'Document must declare a default paragraph style.'
+            end
+            xml['w'].docDefaults do
+              xml['w'].rPrDefault do
+                xml['w'].rPr do
+                  xml['w'].rFonts font_options(s)
+                  xml['w'].b({ 'w:val' => (s.style_bold ? '1' : '0') })
+                  xml['w'].i({ 'w:val' => (s.style_italic ? '1' : '0') })
+                  xml['w'].caps({ 'w:val' => (s.style_caps ? '1' : '0') })
+                  xml['w'].smallCaps({ 'w:val' => '0' })
+                  xml['w'].strike({ 'w:val' => '0' })
+                  xml['w'].color({ 'w:val' => s.style_color })
+                  xml['w'].sz({ 'w:val' => s.style_size })
+                  xml['w'].u({ 'w:val' => (s.style_underline ? 'single' : 'none') })
+                  xml['w'].vertAlign({ 'w:val' => 'baseline' })
+                end
+              end
+              xml['w'].pPrDefault do
+                xml['w'].pPr do
+                  xml['w'].keepNext({ 'w:val' => '0' })
+                  xml['w'].keepLines({ 'w:val' => '0' })
+                  xml['w'].widowControl({ 'w:val' => '1' })
+                  xml['w'].spacing(spacing_options(s, true))
+                  xml['w'].ind(indentation_options(s, true))
+                  xml['w'].jc({ 'w:val' => s.style_align.to_s })
+                end
+              end
+            end
+            xml['w'].style({ 'w:styleId' => s.style_id, 'w:type' => 'paragraph', 'w:default' => '1' }) do
+              xml['w'].name({ 'w:val' => s.style_name })
+            end
+            xml['w'].style({ 'w:styleId' => 'TableNormal', 'w:type' => 'table', 'w:default' => '1' }) do
+              xml['w'].name({ 'w:val' => 'Table Normal'})
+              xml['w'].pPr do
+                xml['w'].spacing({ 'w:lineRule' => 'auto', 'w:line' => (s.style_size * 20 * 1.15), 'w:before' => '0', 'w:after' => '0' })
+              end
+            end
+            default_id = s.style_id
+
+
+            #========== PARA/CHAR STYLES ==================
+
+            document.styles.reject { |s| s.style_id == default_id }.each do |s|
+              xml['w'].style({ 'w:styleId' => s.style_id, 'w:type' => s.style_type }) do
+                xml['w'].name({ 'w:val' => s.style_name })
+                xml['w'].basedOn({ 'w:val' => s.style_base })
+                xml['w'].next({ 'w:val' => s.style_next })
+                xml['w'].pPr do
+                  xml['w'].keepNext({ 'w:val' => '0' })
+                  xml['w'].keepLines({ 'w:val' => '0' })
+                  xml['w'].widowControl({ 'w:val' => '1' })
+                  xml['w'].spacing(spacing_options(s)) unless spacing_options(s).nil?
+                  xml['w'].contextualSpacing({ 'w:val' => '1' })
+                  xml['w'].jc({ 'w:val' => s.style_align.to_s }) unless s.style_align.nil?
+                  xml['w'].ind(indentation_options(s)) unless indentation_options(s).nil?
+                end
+                xml['w'].rPr do
+                  xml['w'].rFonts(font_options(s)) unless s.style_font.nil?
+                  xml['w'].b({ 'w:val' => (s.style_bold ? '1' : '0') } ) unless s.style_bold.nil?
+                  xml['w'].i({ 'w:val' => (s.style_italic ? '1' : '0') }) unless s.style_italic.nil?
+                  xml['w'].caps({ 'w:val' => (s.style_caps ? '1' : '0') }) unless s.style_caps.nil?
+                  xml['w'].color({ 'w:val' => s.style_color }) unless s.style_color.nil?
+                  xml['w'].sz({ 'w:val' => s.style_size }) unless s.style_size.nil?
+                  xml['w'].u({ 'w:val' => (s.style_underline ? 'single' : 'none') }) unless s.style_underline.nil?
+                end
+              end
+            end
+
+            #========== TABLE STYLES ======================
+
+            xml['w'].style({ 'w:styleId' => 'DefaultTable', 'w:type' => 'table' }) do
+              xml['w'].basedOn({ 'w:val' => 'TableNormal' })
+              xml['w'].tblPr do
+                xml['w'].tblStyleRowBandSize({ 'w:val' => '1' })
+                xml['w'].tblStyleColBandSize({ 'w:val' => '1' })
+              end
+              %w(band1Horz band1Vert band2Horz band2Vert).each do |type|
+                xml['w'].tblStylePr({ 'w:type' => type })
+              end
+              %w(firstCol firstRow lastCol lastRow).each do |type|
+                xml['w'].tblStylePr({ 'w:type' => type })
+              end
+              %w(neCell nwCell seCell swCell).each do |type|
+                xml['w'].tblStylePr({ 'w:type' => type })
+              end
+            end
+
+          end
+        end
+        builder.to_xml(save_options)
+      end
+
+
+
+      #----------------------------------------------------
+      # Private Methods
+      #----------------------------------------------------
+      private
+
+      def font_options(style)
+        name = style.style_font
+        { 'w:cs' => name, 'w:hAnsi' => name, 'w:eastAsia' => name, 'w:ascii' => name }
+      end
+
+      def indentation_options(style, default=false)
+        left    = (default) ? style.style_indent_left.to_i  : style.style_indent_left
+        right   = (default) ? style.style_indent_right.to_i : style.style_indent_right
+        first   = (default) ? style.style_indent_first.to_i : style.style_indent_first
+        options = nil
+        if [left, right, first].compact.size > 0
+          options                  = {}
+          options['w:left']        = left    unless left.nil?
+          options['w:right']       = right   unless right.nil?
+          options['w:firstLine']   = first   unless first.nil?
+        end
+        options
+      end
+
+      def root_options
+        {
+          'xmlns:mc'  => 'http://schemas.openxmlformats.org/markup-compatibility/2006',
+          'xmlns:o'   => 'urn:schemas-microsoft-com:office:office',
+          'xmlns:r'   => 'http://schemas.openxmlformats.org/officeDocument/2006/relationships',
+          'xmlns:m'   => 'http://schemas.openxmlformats.org/officeDocument/2006/math',
+          'xmlns:v'   => 'urn:schemas-microsoft-com:vml',
+          'xmlns:wp'  => 'http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing',
+          'xmlns:w10' => 'urn:schemas-microsoft-com:office:word',
+          'xmlns:w'   => 'http://schemas.openxmlformats.org/wordprocessingml/2006/main',
+          'xmlns:wne' => 'http://schemas.microsoft.com/office/word/2006/wordml',
+          'xmlns:sl'  => 'http://schemas.openxmlformats.org/schemaLibrary/2006/main',
+          'xmlns:a'   => 'http://schemas.openxmlformats.org/drawingml/2006/main',
+          'xmlns:pic' => 'http://schemas.openxmlformats.org/drawingml/2006/picture',
+          'xmlns:c'   => 'http://schemas.openxmlformats.org/drawingml/2006/chart',
+          'xmlns:lc'  => 'http://schemas.openxmlformats.org/drawingml/2006/lockedCanvas',
+          'xmlns:dgm' => 'http://schemas.openxmlformats.org/drawingml/2006/diagram'
+        }
+      end
+
+      def spacing_options(style, default=false)
+        top     = (default) ? style.style_top.to_i    : style.style_top
+        bottom  = (default) ? style.style_bottom.to_i : style.style_bottom
+        line    = style.style_line
+
+        options = nil
+        if [top, bottom, line].compact.size > 0
+          options               = {}
+          options['w:lineRule'] = 'auto'
+          options['w:before']   = top      unless top.nil?
+          options['w:after']    = bottom   unless bottom.nil?
+          options['w:line']     = line     unless line.nil?
+        end
+        options
+      end
+
+    end
+  end
+end

data/lib/caracal/renderers/xml_renderer.rb

@@ -0,0 +1,83 @@
+require 'nokogiri'
+
+
+module Caracal
+  module Renderers
+    class XmlRenderer
+
+      #-------------------------------------------------------------
+      # Configuration
+      #-------------------------------------------------------------
+
+      attr_reader :document
+
+
+      #-------------------------------------------------------------
+      # Class Methods
+      #-------------------------------------------------------------
+
+      # This method produces xml output for the given document
+      # according to the rules of this renderer object.
+      #
+      def self.render(doc)
+        renderer = new(doc)
+        renderer.to_xml
+      end
+
+
+      #-------------------------------------------------------------
+      # Public Methods
+      #-------------------------------------------------------------
+
+      # This method instantiates a new verison of this renderer.
+      #
+      def initialize(doc)
+        unless doc.is_a?(Caracal::Document)
+          raise NoDocumentError, 'renderers must receive a reference to a valid Caracal document object.'
+        end
+
+        @document = doc
+      end
+
+      # This method converts data in the specified document to XML.
+      # A concrete implementation must be provided by the subclass.
+      #
+      def to_xml
+        raise NotImplementedError, 'renderers must implement the method :to_xml.'
+      end
+
+
+      #-------------------------------------------------------------
+      # Private Methods
+      #-------------------------------------------------------------
+      private
+
+      # This method returns a Nokogiri::XML object that contains the
+      # specific declaration we want.
+      #
+      def declaration_xml
+        ::Nokogiri::XML('<?xml version = "1.0" encoding = "UTF-8" standalone ="yes"?>')
+      end
+
+      # This method returns a commonly used set of attributes for paragraph nodes.
+      #
+      def paragraph_options
+        { 'w:rsidP' => '00000000', 'w:rsidRDefault' => '00000000' }.merge(run_options)
+      end
+
+      # This method returns a commonly used set of attributes for text run nodes.
+      #
+      def run_options
+        { 'w:rsidR' => '00000000', 'w:rsidRPr' => '00000000', 'w:rsidDel' => '00000000' }
+      end
+
+      # These save options force Nokogiri to remove indentation and
+      # line feeds from the output.
+      #
+      def save_options
+        { save_with: Nokogiri::XML::Node::SaveOptions::AS_XML }
+      end
+
+    end
+  end
+end