caracal 0.1.0

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.send 'w:fonts', root_options do
+            document.fonts.each do |font|
+              xml.send '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,69 @@
+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.send 'w:ftr', root_options do
+            xml.send 'w:p', paragraph_options do
+              xml.send 'w:pPr' do
+                xml.send 'w:contextualSpacing', { 'w:val' => '0' }
+                xml.send 'w:jc', { 'w:val' => "#{ document.page_number_align }" }
+              end
+              xml.send 'w:fldSimple', { 'w:dirty' => '0', 'w:instr' => 'PAGE', 'w:fldLock' => '0' } do
+                xml.send 'w:r', run_options do
+                  xml.send 'w:rPr'
+                end
+              end
+              xml.send 'w:r', run_options do
+                xml.send 'w:rPr' do
+                  xml.send '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,87 @@
+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.send 'w:numbering', root_options do
+            
+            # add abstract definitions
+            document.toplevel_lists.each_with_index do |model, i|
+              xml.send 'w:abstractNum', { 'w:abstractNumId' => i + 1 } do
+                model.level_map.each do |(level, type)|
+                  if s = document.find_list_style(type, level)
+                    xml.send 'w:lvl', { 'w:ilvl' => s.style_level } do
+                      xml.send 'w:start',      { 'w:val' => s.style_start }
+                      xml.send 'w:numFmt',     { 'w:val' => s.style_format }
+                      xml.send 'w:lvlRestart', { 'w:val' => s.formatted_restart }
+                      xml.send 'w:lvlText',    { 'w:val' => s.style_value }
+                      xml.send 'w:lvlJc',      { 'w:val' => s.style_align }
+                      xml.send 'w:pPr' do
+                        xml.send 'w:ind', { 'w:left' => s.style_left, 'w:firstLine' => s.style_line }
+                      end
+                      xml.send 'w:rPr' do
+                        xml.send '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.send 'w:num', { 'w:numId' => i + 1 } do
+                xml.send '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,50 @@
+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'],
+          ['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.send 'w:settings', root_options do
+            xml.send 'w:displayBackgroundShape', { 'w:val' => '1' }
+            xml.send 'w:defaultTabStop', { 'w:val' => '720' }
+            xml.send 'w:compat' do
+              xml.send '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,163 @@
+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.send '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.send 'w:docDefaults' do
+              xml.send 'w:rPrDefault' do
+                xml.send 'w:rPr' do
+                  xml.send 'w:rFonts',    font_options(s)
+                  xml.send 'w:b',         { 'w:val' => (s.style_bold ? '1' : '0') }
+                  xml.send 'w:i',         { 'w:val' => (s.style_italic ? '1' : '0') }
+                  xml.send 'w:smallCaps', { 'w:val' => '0' }
+                  xml.send 'w:strike',    { 'w:val' => '0' }
+                  xml.send 'w:color',     { 'w:val' => s.style_color }
+                  xml.send 'w:sz',        { 'w:val' => s.style_size }
+                  xml.send 'w:u',         { 'w:val' => (s.style_underline ? 'single' : 'none') }
+                  xml.send 'w:vertAlign', { 'w:val' => 'baseline' }
+                end
+              end
+              xml.send 'w:pPrDefault' do
+                xml.send 'w:pPr' do
+                  xml.send 'w:keepNext',     { 'w:val' => '0' }
+                  xml.send 'w:keepLines',    { 'w:val' => '0' }
+                  xml.send 'w:widowControl', { 'w:val' => '1' }
+                  xml.send 'w:spacing',      { 'w:lineRule' => 'auto', 'w:line' => s.style_line, 'w:before' => '0', 'w:after' => '0' }
+                  xml.send 'w:ind',          { 'w:left' => '0', 'w:firstLine' => '0', 'w:right' => '0' }
+                  xml.send 'w:jc',           { 'w:val' => s.style_align.to_s }
+                end
+              end
+            end
+            xml.send 'w:style', { 'w:styleId' => s.style_id, 'w:type' => 'paragraph', 'w:default' => '1' } do
+              xml.send 'w:name', { 'w:val' => s.style_name }
+            end
+            xml.send 'w:style', { 'w:styleId' => 'TableNormal', 'w:type' => 'table', 'w:default' => '1' } do
+              xml.send 'w:name', { 'w:val' => 'Table Normal'}
+              xml.send 'w:pPr' do
+                xml.send '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
+            
+            
+            #============ PARAGRAPH STYLES ================================
+            
+            document.styles.reject { |s| s.style_id == default_id }.each do |s|
+              xml.send 'w:style', { 'w:styleId' => s.style_id, 'w:type' => 'paragraph' } do
+                xml.send 'w:name',    { 'w:val' => s.style_name }
+                xml.send 'w:basedOn', { 'w:val' => s.style_base }
+                xml.send 'w:next',    { 'w:val' => s.style_next }
+                xml.send 'w:pPr' do
+                  xml.send 'w:keepNext',          { 'w:val' => '1' }
+                  xml.send 'w:keepLines',         { 'w:val' => '1' }
+                  xml.send 'w:spacing',           spacing_options(s)                              unless spacing_options(s).nil?
+                  xml.send 'w:contextualSpacing', { 'w:val' => '1' }
+                  xml.send 'w:jc',                { 'w:val' => s.style_align.to_s }               unless s.style_align.nil?
+                end
+                xml.send 'w:rPr' do
+                  xml.send 'w:rFonts',    font_options(s)                                         unless s.style_font.nil?
+                  xml.send 'w:b',         { 'w:val' => (s.style_bold ? '1' : '0') }               unless s.style_bold.nil?
+                  xml.send 'w:i',         { 'w:val' => (s.style_italic ? '1' : '0') }             unless s.style_italic.nil?
+                  xml.send 'w:color',     { 'w:val' => s.style_color }                            unless s.style_color.nil?
+                  xml.send 'w:sz',        { 'w:val' => s.style_size }                             unless s.style_size.nil?
+                  xml.send 'w:u',         { 'w:val' => (s.style_underline ? 'single' : 'none') }  unless s.style_underline.nil?
+                end
+              end
+            end
+            
+            #============ TABLE STYLES ================================
+            
+            xml.send 'w:style', { 'w:styleId' => 'DefaultTable', 'w:type' => 'table' } do
+              xml.send 'w:basedOn', { 'w:val' => 'TableNormal' }
+              xml.send 'w:tblPr' do
+                xml.send 'w:tblStyleRowBandSize', { 'w:val' => '1' }
+                xml.send 'w:tblStyleColBandSize', { 'w:val' => '1' }
+              end
+              %w(band1Horz band1Vert band2Horz band2Vert).each do |type|
+                xml.send 'w:tblStylePr', { 'w:type' => type }
+              end
+              %w(firstCol firstRow lastCol lastRow).each do |type|
+                xml.send 'w:tblStylePr', { 'w:type' => type }
+              end
+              %w(neCell nwCell seCell swCell).each do |type|
+                xml.send '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 spacing_options(style)
+        top     = style.style_top
+        bottom  = 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
+      
+      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