caracal_the_curve 1.4.1 → 1.4.3

data/lib/caracal/document.rb

@@ -3,8 +3,11 @@ require 'zip'
 
 require 'caracal/core/bookmarks'
 require 'caracal/core/custom_properties'
+require 'caracal/core/fields'
 require 'caracal/core/file_name'
 require 'caracal/core/fonts'
+require 'caracal/core/footer'
+require 'caracal/core/header'
 require 'caracal/core/iframes'
 require 'caracal/core/ignorables'
 require 'caracal/core/images'
@@ -12,12 +15,14 @@ require 'caracal/core/list_styles'
 require 'caracal/core/lists'
 require 'caracal/core/namespaces'
 require 'caracal/core/page_breaks'
+require 'caracal/core/page_flips'
 require 'caracal/core/page_numbers'
 require 'caracal/core/page_settings'
 require 'caracal/core/relationships'
 require 'caracal/core/rules'
 require 'caracal/core/styles'
 require 'caracal/core/tables'
+require 'caracal/core/table_of_contents'
 require 'caracal/core/text'
 
 require 'caracal/renderers/app_renderer'
@@ -27,6 +32,7 @@ require 'caracal/renderers/custom_renderer'
 require 'caracal/renderers/document_renderer'
 require 'caracal/renderers/fonts_renderer'
 require 'caracal/renderers/footer_renderer'
+require 'caracal/renderers/header_renderer'
 require 'caracal/renderers/numbering_renderer'
 require 'caracal/renderers/package_relationships_renderer'
 require 'caracal/renderers/relationships_renderer'
@@ -55,14 +61,19 @@ module Caracal
     include Caracal::Core::ListStyles
 
     include Caracal::Core::Bookmarks
+    include Caracal::Core::Fields
     include Caracal::Core::IFrames
     include Caracal::Core::Images
     include Caracal::Core::Lists
+    include Caracal::Core::PageFlips
     include Caracal::Core::PageBreaks
     include Caracal::Core::Rules
     include Caracal::Core::Tables
+    include Caracal::Core::TableOfContents
     include Caracal::Core::Text
 
+    include Caracal::Core::Footer
+    include Caracal::Core::Header
 
     #------------------------------------------------------
     # Public Class Methods
@@ -129,6 +140,13 @@ module Caracal
       @contents ||= []
     end
 
+    def footer_content
+      @footer_content
+    end
+
+    def header_content
+      @header_content
+    end
 
     #============ RENDERING ===============================
 
@@ -144,6 +162,7 @@ module Caracal
         render_custom(zip)
         render_fonts(zip)
         render_footer(zip)
+        render_header(zip)
         render_settings(zip)
         render_styles(zip)
         render_document(zip)
@@ -219,6 +238,13 @@ module Caracal
       zip.write(content)
     end
 
+    def render_header(zip)
+      content = ::Caracal::Renderers::HeaderRenderer.render(self)
+
+      zip.put_next_entry('word/header1.xml')
+      zip.write(content)
+    end
+
     def render_media(zip)
       images = relationships.select { |r| r.relationship_type == :image }
       images.each do |rel|

data/lib/caracal/renderers/content_types_renderer.rb

@@ -28,6 +28,7 @@ module Caracal
             xml.send 'Override', { 'PartName' => '/docProps/custom.xml', 'ContentType' => 'application/vnd.openxmlformats-officedocument.custom-properties+xml' }
             xml.send 'Override', { 'PartName' => '/word/document.xml',   'ContentType' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml' }
             xml.send 'Override', { 'PartName' => '/word/footer1.xml',    'ContentType' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.footer+xml' }
+            xml.send 'Override', { 'PartName' => '/word/header1.xml',    'ContentType' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.header+xml' }
             xml.send 'Override', { 'PartName' => '/word/fontTable.xml',  'ContentType' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.fontTable+xml' }
             xml.send 'Override', { 'PartName' => '/word/numbering.xml',  'ContentType' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.numbering+xml' }
             xml.send 'Override', { 'PartName' => '/word/settings.xml',   'ContentType' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.settings+xml' }

data/lib/caracal/renderers/document_renderer.rb

@@ -31,10 +31,11 @@ module Caracal
               #============= PAGE SETTINGS ==============================
 
               xml['w'].sectPr do
-                if document.page_number_show
-                  if rel = document.find_relationship('footer1.xml')
-                    xml['w'].footerReference({ 'r:id' => rel.formatted_id, 'w:type' => 'default' })
-                  end
+                if rel = document.find_relationship('footer1.xml')
+                  xml['w'].footerReference({ 'r:id' => rel.formatted_id, 'w:type' => 'default' })
+                end
+                if rel = document.find_relationship('header1.xml')
+                  xml['w'].headerReference({ 'r:id' => rel.formatted_id, 'w:type' => 'default' })
                 end
                 xml['w'].pgSz page_size_options
                 xml['w'].pgMar page_margin_options
@@ -219,6 +220,79 @@ module Caracal
         end
       end
 
+      def render_tableofcontents(xml, model)
+        xml['w'].sdt do
+          xml['w'].sdtPr do
+            xml['w'].docPartObj do
+              xml['w'].docPartGallery({ 'w:val' => model.toc_title })
+              xml['w'].docPartUnique({ 'w:val' => true })
+            end
+          end
+          xml['w'].sdtContent do
+            xml['w'].p do
+              xml['w'].pPr do
+                xml['w'].pStyle({ 'w:val' => 'ContentsHeading' })
+                xml['w'].rPr do
+                  xml['w'].b
+                  xml['w'].b
+                  xml['w'].bCs
+                  xml['w'].sz({ 'w:val' => model.toc_size })
+                  xml['w'].szCs({ 'w:val' => model.toc_size })
+                end
+              end
+              xml['w'].r do
+                  xml['w'].rPr do
+                  xml['w'].b
+                  xml['w'].bCs
+                  xml['w'].sz({ 'w:val' => model.toc_size })
+                  xml['w'].szCs({ 'w:val' => model.toc_size })
+                end
+                xml['w'].t model.toc_title
+              end
+            end
+            xml['w'].p do
+              xml['w'].r do
+                xml['w'].fldChar({ 'w:fldCharType' => 'begin' })
+              end
+              xml['w'].r do
+                xml['w'].rPr do
+                  render_run_attributes(xml, model, false)
+                end
+                xml['w'].instrText({ 'xml:space' => 'preserve' }) do
+                  xml.text " #{model.toc_opts} "
+                end
+              end
+              xml['w'].r do
+                xml['w'].fldChar({ 'w:fldCharType' => 'separate' })
+              end
+              xml['w'].r do
+                xml['w'].fldChar({ 'w:fldCharType' => 'end' })
+              end
+            end
+          end
+        end
+      end
+
+      def render_field(xml, model)
+        xml['w'].r do
+          xml['w'].fldChar({ 'w:fldCharType' => 'begin' })
+        end
+        xml['w'].r do
+          xml['w'].rPr do
+            render_run_attributes(xml, model, false)
+          end
+          xml['w'].instrText({ 'xml:space' => 'preserve' }) do
+            xml.text " #{model.formatted_type} "
+          end
+        end
+        xml['w'].r do
+          xml['w'].fldChar({ 'w:fldCharType' => 'separate' })
+        end
+        xml['w'].r do
+          xml['w'].fldChar({ 'w:fldCharType' => 'end' })
+        end
+      end
+
       def render_list(xml, model)
         if model.list_level == 0
           document.toplevel_lists << model
@@ -253,6 +327,33 @@ module Caracal
         end
       end
 
+      def render_pageflip(xml, model)
+        xml['w'].p paragraph_options do
+          xml['w'].pPr do
+            xml['w'].sectPr do
+              xml['w'].pgSz({
+                'w:w' => document.page_width,
+                'w:h' => document.page_height
+              })
+            end
+          end
+        end
+        model.contents.each do |model|
+          method = render_method_for_model(model)
+          send(method, xml, model)
+        end
+        xml['w'].p paragraph_options do
+          xml['w'].pPr do
+            xml['w'].sectPr do
+              xml['w'].pgSz({
+                'w:w' => document.page_height,
+                'w:h' => document.page_width
+              })
+            end
+          end
+        end
+      end
+
       def render_pagebreak(xml, model)
         if model.page_break_wrap
           xml['w'].p paragraph_options do

data/lib/caracal/renderers/footer_renderer.rb

@@ -5,52 +5,65 @@ require 'caracal/renderers/xml_renderer'
 
 module Caracal
   module Renderers
-    class FooterRenderer < XmlRenderer
+    class FooterRenderer < DocumentRenderer
 
       #-------------------------------------------------------------
       # Public Methods
       #-------------------------------------------------------------
 
-      # This method produces the xml required for the `word/settings.xml`
+      # This method produces the xml required for the `word/footer1.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?
+          if document.page_number_show
+            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
-                    xml['w'].rStyle({ 'w:val' => 'PageNumber' })
-                    unless document.page_number_label_size.nil?
-                      xml['w'].sz({ 'w:val'  => document.page_number_label_size })
+                    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'].t({ 'xml:space' => 'preserve' }) do
-                    xml.text "#{ document.page_number_label } "
+                  xml['w'].fldChar({ 'w:fldCharType' => 'begin' })
+                  xml['w'].instrText({ 'xml:space' => 'preserve' }) do
+                    xml.text 'PAGE'
                   end
+                  xml['w'].fldChar({ 'w:fldCharType' => '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 })
+                xml['w'].r run_options do
+                  xml['w'].rPr do
+                    xml['w'].rtl({ 'w:val' => '0' })
                   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
+          else
+            xml['w'].ftr root_options do
+
+              #============= CONTENTS ===================================
+              if document.footer_content&.valid?
+                document.footer_content.contents.each do |model|
+                  method = render_method_for_model(model)
+                  send(method, xml, model)
                 end
               end
             end
@@ -87,4 +100,4 @@ module Caracal
 
     end
   end
-end
+end

data/lib/caracal/renderers/header_renderer.rb

@@ -0,0 +1,61 @@
+require 'nokogiri'
+
+require 'caracal/renderers/xml_renderer'
+
+
+module Caracal
+  module Renderers
+    class HeaderRenderer < DocumentRenderer
+
+      #-------------------------------------------------------------
+      # Public Methods
+      #-------------------------------------------------------------
+
+      # This method produces the xml required for the `word/header1.xml`
+      # sub-document.
+      #
+      def to_xml
+        builder = ::Nokogiri::XML::Builder.with(declaration_xml) do |xml|
+          xml['w'].hdr root_options do
+
+              #============= CONTENTS ===================================
+            if document.header_content&.valid?
+              document.header_content.contents.each do |model|
+                method = render_method_for_model(model)
+                send(method, xml, model)
+              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/settings_renderer.rb

@@ -22,6 +22,7 @@ module Caracal
             xml['w'].compat do
               xml['w'].compatSetting({ 'w:val' => '14', 'w:name' => 'compatibilityMode', 'w:uri' => 'http://schemas.microsoft.com/office/word' })
             end
+            xml['w'].updateFields({ 'w:val' => true })
           end
         end
         builder.to_xml(save_options)
@@ -55,4 +56,4 @@ module Caracal
    
     end
   end
-end
+end

data/lib/caracal/renderers/styles_renderer.rb

@@ -31,6 +31,7 @@ module Caracal
                   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'].outlineLvl({ 'w:val' => s.style_outline })
                   xml['w'].smallCaps({ 'w:val' => '0' })
                   xml['w'].strike({ 'w:val' => '0' })
                   xml['w'].color({ 'w:val' => s.style_color })
@@ -75,6 +76,7 @@ module Caracal
                   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'].outlineLvl({ 'w:val' => s.style_outline }) unless s.style_outline.nil?
                   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

data/lib/caracal/version.rb

@@ -1,3 +1,3 @@
 module Caracal
-  VERSION = '1.4.1'
+  VERSION = '1.4.3'
 end

data/lib/caracal.rb

@@ -38,3 +38,27 @@ Caracal::Core::Models::TableCellModel.class_eval do
   include Caracal::Core::Tables
   include Caracal::Core::Text
 end
+
+Caracal::Core::Models::PageFlipModel.class_eval do
+  include Caracal::Core::Images
+  include Caracal::Core::Lists
+  include Caracal::Core::Rules
+  include Caracal::Core::Tables
+  include Caracal::Core::Text
+end
+
+Caracal::Core::Models::FooterModel.class_eval do
+  include Caracal::Core::Images
+  include Caracal::Core::Lists
+  include Caracal::Core::Rules
+  include Caracal::Core::Tables
+  include Caracal::Core::Text
+end
+
+Caracal::Core::Models::HeaderModel.class_eval do
+  include Caracal::Core::Images
+  include Caracal::Core::Lists
+  include Caracal::Core::Rules
+  include Caracal::Core::Tables
+  include Caracal::Core::Text
+end

data/spec/lib/caracal/core/fields_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Caracal::Core::Fields do
+  subject { Caracal::Document.new }
+  
+  
+  #-------------------------------------------------------------
+  # Public Methods
+  #-------------------------------------------------------------
+
+  describe 'public method tests' do
+    
+    # .table
+    describe '.field' do
+      let!(:size) { subject.contents.size }
+      
+      before { subject.field :table_of_contents }
+      
+      it { expect(subject.contents.size).to eq size + 1 }
+      it { expect(subject.contents.last).to be_a(Caracal::Core::Models::FieldModel) }
+    end
+    
+  end
+  
+end

data/spec/lib/caracal/core/footer_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Caracal::Core::Text do
+  subject { Caracal::Document.new }
+
+  #-------------------------------------------------------------
+  # Configuration
+  #-------------------------------------------------------------
+
+  describe 'configuration tests' do
+
+    # accessors
+    describe 'accessors' do
+      it { expect(subject.footer_content).to be_nil }
+    end
+  end
+
+  #-------------------------------------------------------------
+  # Public Methods
+  #-------------------------------------------------------------
+
+  describe 'public method tests' do
+
+    describe '.footer' do
+      before { subject.footer }
+
+      it { expect(subject.footer_content).not_to be_nil }
+      it { expect(subject.footer_content).to be_a(Caracal::Core::Models::FooterModel) }
+    end
+  end
+end

data/spec/lib/caracal/core/header_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Caracal::Core::Text do
+  subject { Caracal::Document.new }
+
+  #-------------------------------------------------------------
+  # Configuration
+  #-------------------------------------------------------------
+
+  describe 'configuration tests' do
+
+    # accessors
+    describe 'accessors' do
+      it { expect(subject.header_content).to be_nil }
+    end
+  end
+
+  #-------------------------------------------------------------
+  # Public Methods
+  #-------------------------------------------------------------
+
+  describe 'public method tests' do
+
+    describe '.header' do
+      before { subject.header }
+
+      it { expect(subject.header_content).not_to be_nil }
+      it { expect(subject.header_content).to be_a(Caracal::Core::Models::HeaderModel) }
+    end
+  end
+end

data/spec/lib/caracal/core/models/footer_model_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe Caracal::Core::Models::FooterModel do
+  subject do
+    described_class.new
+  end
+
+  #-------------------------------------------------------------
+  # Public Methods
+  #-------------------------------------------------------------
+
+  describe 'public method tests' do
+
+    #=============== DATA ACCESSORS ====================
+
+    describe 'data tests' do
+
+      # .contents
+      describe '.contents' do
+        it { expect(subject.contents).to be_a(Array) }
+      end
+    end
+
+    #=============== VALIDATION ========================
+
+    describe '.valid?' do
+      describe 'when content provided' do
+        before { allow(subject).to receive(:contents).and_return(['a']) }
+
+        it { expect(subject.valid?).to eq true }
+      end
+
+      describe 'when content not provided' do
+        before { allow(subject).to receive(:contents).and_return([]) }
+
+        it { expect(subject.valid?).to eq false }
+      end
+    end
+  end
+end

data/spec/lib/caracal/core/models/header_model_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe Caracal::Core::Models::HeaderModel do
+  subject do
+    described_class.new
+  end
+
+  #-------------------------------------------------------------
+  # Public Methods
+  #-------------------------------------------------------------
+
+  describe 'public method tests' do
+
+    #=============== DATA ACCESSORS ====================
+
+    describe 'data tests' do
+
+      # .contents
+      describe '.contents' do
+        it { expect(subject.contents).to be_a(Array) }
+      end
+    end
+
+    #=============== VALIDATION ========================
+
+    describe '.valid?' do
+      describe 'when content provided' do
+        before { allow(subject).to receive(:contents).and_return(['a']) }
+
+        it { expect(subject.valid?).to eq true }
+      end
+
+      describe 'when content not provided' do
+        before { allow(subject).to receive(:contents).and_return([]) }
+
+        it { expect(subject.valid?).to eq false }
+      end
+    end
+  end
+end

data/spec/lib/caracal/core/models/page_flip_model_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Caracal::Core::Models::PageFlipModel do
+  let(:name) { 'Arial' }
+  
+  subject { described_class.new }
+  
+  
+  #-------------------------------------------------------------
+  # Configuration
+  #-------------------------------------------------------------
+  
+  describe 'configuration tests' do
+    
+    describe 'inheritance' do
+      it { expect(subject).to be_a(Caracal::Core::Models::BaseModel) }
+    end
+  end
+
+  #=============== VALIDATION ===========================
+
+  describe '.valid?' do
+    describe 'when content provided' do
+      before { allow(subject).to receive(:contents).and_return(['a']) }
+      
+      it { expect(subject.valid?).to eq true }
+    end
+    describe 'when content not provided' do
+      before { allow(subject).to receive(:contents).and_return([]) }
+      
+      it { expect(subject.valid?).to eq false }
+    end
+  end
+end