caracal_the_curve 1.4.1 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f5d4a9ccb930cc2eb43e169140f9b47626f4713afa525322a0c7f864603875a
-  data.tar.gz: 41cf0b1af0c1f09f710380f779d12f9509c207b99eddfbe2b69f4dc4b3ca0f03
+  metadata.gz: d1d56aaed7b0a4ebaa54b3e1ec9676a9b1ad7623f3731fcaf39f5b36dbfc9aa8
+  data.tar.gz: aaee3a57ce1de0605812daf5fb1723b591df0ade1258d01e198b6fef14b7faa9
 SHA512:
-  metadata.gz: e993e86c44852e6ac98f8aa4cc4c777e954ccb09bbe7742fba541fc71d534e11fffae8368d2ad9ec5b02240a20406fa504fd0a8b1dd6050140123b642ac7e196
-  data.tar.gz: 00acddad9a31fef96b827b1874eef89d05f92e86393ab741c9ed73840eb8e4cfde0f4668ca30f7d458f71e280398423cabe4cfb77456f6ebf1c4c7857e90b99d
+  metadata.gz: a70c88b1cb4b1ced216bbc9d2f6b30557e05a951e9021ec1996c79f8243ea3920b7b1a61cfb391e119748bf4aa3c506606b141814d906f9787d38d854da2b23f
+  data.tar.gz: '01650682a67a3e887eef14c14c7145eebd28afec184aa75214575711a6998d8ca6048bd517ac73100b79ca53d1fd8e12c2633c881cd389b90ec4fa88ad6dc69f'

data/caracal.gemspec

@@ -6,8 +6,8 @@ require 'caracal/version'
 Gem::Specification.new do |spec|
   spec.name          = 'caracal_the_curve'
   spec.version       = Caracal::VERSION
-  spec.authors       = ['Trade Infomatics', 'John Dugan']
-  spec.email         = ['jpdugan@gmail.com']
+  spec.authors       = ['Trade Infomatics', 'John Dugan', 'James Ridgway', 'Matthew Barber']
+  spec.email         = ['jpdugan@gmail.com', 'james.ridgway@tccs.io', 'matthew.barber@tccs.io']
   spec.summary       = %q{ Fast, professional Microsoft Word (docx) writer for Ruby. }
   spec.description   = %q{ Caracal is a pure Ruby Microsoft Word generation library that produces professional quality MSWord documents (docx) using a simple, HTML-style DSL. }
   spec.homepage      = 'https://github.com/trade-informatics/caracal'

data/lib/caracal/core/fields.rb

@@ -0,0 +1,34 @@
+require 'caracal/core/models/field_model'
+require 'caracal/errors'
+
+
+module Caracal
+  module Core
+
+    # This module encapsulates all the functionality related to fields
+    #
+    module Fields
+      def self.included(base)
+        base.class_eval do
+
+          #-------------------------------------------------------------
+          # Public Methods
+          #-------------------------------------------------------------
+
+          def field(*args, &block)
+            options = Caracal::Utilities.extract_options!(args)
+            options.merge!({ type: args.first }) if args.first
+
+            model = Caracal::Core::Models::FieldModel.new(options, &block)
+            
+            if model.valid?
+              contents << model
+            end
+
+            model
+          end
+        end
+      end
+    end
+  end
+end

data/lib/caracal/core/footer.rb

@@ -0,0 +1,33 @@
+require 'caracal/core/models/footer_model'
+require 'caracal/errors'
+
+
+module Caracal
+  module Core
+
+    # This module encapsulates all the functionality related to adding a
+    # footer on every page of the document.
+    #
+    module Footer
+      def self.included(base)
+        base.class_eval do
+
+          #-------------------------------------------------------------
+          # Public Methods
+          #-------------------------------------------------------------
+
+          def footer(*args, &block)
+            options = Caracal::Utilities.extract_options!(args)
+
+            model = Caracal::Core::Models::FooterModel.new(options, &block)
+
+            @footer_content = model
+
+            model
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/caracal/core/header.rb

@@ -0,0 +1,32 @@
+require 'caracal/core/models/header_model'
+require 'caracal/errors'
+
+
+module Caracal
+  module Core
+
+    # This module encapsulates all the functionality related to adding a header
+    # to every page of the document.
+    #
+    module Header
+      def self.included(base)
+        base.class_eval do
+
+          #-------------------------------------------------------------
+          # Public Methods
+          #-------------------------------------------------------------
+
+          def header(*args, &block)
+            options = Caracal::Utilities.extract_options!(args)
+
+            model = Caracal::Core::Models::HeaderModel.new(options, &block)
+
+            @header_content = model
+
+            model
+          end
+        end
+      end
+    end
+  end
+end

data/lib/caracal/core/models/field_model.rb

@@ -0,0 +1,124 @@
+require 'caracal/core/models/base_model'
+
+
+module Caracal
+  module Core
+    module Models
+
+      # This class encapsulates the logic needed to store and manipulate
+      # text data.
+      #
+      class FieldModel < BaseModel
+
+        #--------------------------------------------------
+        # Configuration
+        #--------------------------------------------------
+
+        # constants
+        const_set(:TYPE_MAP, { page: 'PAGE', numpages: 'NUMPAGES', table_of_contents: 'TOC \o "1-1" \h \z \u \t "Heading 5,1"' })
+
+        # accessors
+        attr_reader :field_dirty
+        attr_reader :field_type
+        attr_reader :field_style
+        attr_reader :field_font
+        attr_reader :field_color
+        attr_reader :field_size
+        attr_reader :field_bold
+        attr_reader :field_italic
+        attr_reader :field_underline
+        attr_reader :field_bgcolor
+        attr_reader :field_highlight_color
+        attr_reader :field_vertical_align
+
+        #-------------------------------------------------------------
+        # Public Class Methods
+        #-------------------------------------------------------------
+
+        def self.formatted_type(type)
+          TYPE_MAP.fetch(type.to_s.to_sym)
+        end
+
+
+        #-------------------------------------------------------------
+        # Public Instance Methods
+        #-------------------------------------------------------------
+
+        #=============== GETTERS ==============================
+
+        def formatted_type
+          self.class.formatted_type(field_type)
+        end
+
+        #========== GETTERS ===============================
+
+        # .run_attributes
+        def run_attributes
+          {
+            style:            field_style,
+            font:             field_font,
+            color:            field_color,
+            size:             field_size,
+            bold:             field_bold,
+            italic:           field_italic,
+            underline:        field_underline,
+            bgcolor:          field_bgcolor,
+            highlight_color:  field_highlight_color,
+            vertical_align:   field_vertical_align
+          }
+        end
+
+
+        #========== SETTERS ===============================
+
+        # booleans
+        [:bold, :italic, :underline].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@field_#{ m }", !!value)
+          end
+        end
+
+        # integers
+        [:size].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@field_#{ m }", value.to_i)
+          end
+        end
+
+        # strings
+        [:bgcolor, :color, :dirty, :font, :highlight_color, :style, :type].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@field_#{ m }", value.to_s)
+          end
+        end
+
+        # symbols
+        [:vertical_align].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@field_#{ m }", value.to_s.to_sym)
+          end
+        end
+
+
+        #========== VALIDATION ============================
+
+        def valid?
+          a = [:type]
+          a.map { |m| send("field_#{ m }") }.compact.size == a.size
+        end
+
+
+        #--------------------------------------------------
+        # Private Methods
+        #--------------------------------------------------
+        private
+
+        def option_keys
+          [:type, :style, :font, :color, :size, :bold, :italic, :underline, :bgcolor, :highlight_color, :vertical_align]
+        end
+
+      end
+
+    end
+  end
+end

data/lib/caracal/core/models/footer_model.rb

@@ -0,0 +1,42 @@
+require 'caracal/core/models/base_model'
+require 'caracal/core/models/margin_model'
+require 'caracal/core/models/paragraph_model'
+
+
+module Caracal
+  module Core
+    module Models
+
+      # This class handles block options passed to tables via their data
+      # collections.
+      #
+      class FooterModel < BaseModel
+
+        #-------------------------------------------------------------
+        # Configuration
+        #-------------------------------------------------------------
+
+        # initialization
+        def initialize(options={}, &block)
+          super options, &block
+        end
+
+        #-------------------------------------------------------------
+        # Public Methods
+        #-------------------------------------------------------------
+
+        #=============== DATA ACCESSORS =======================
+
+        def contents
+          @contents ||= []
+        end
+
+        #=============== VALIDATION ===========================
+
+        def valid?
+          contents.size > 0
+        end
+      end
+    end
+  end
+end

data/lib/caracal/core/models/header_model.rb

@@ -0,0 +1,42 @@
+require 'caracal/core/models/base_model'
+require 'caracal/core/models/margin_model'
+require 'caracal/core/models/paragraph_model'
+
+
+module Caracal
+  module Core
+    module Models
+
+      # This class handles block options passed to tables via their data
+      # collections.
+      #
+      class HeaderModel < BaseModel
+
+        #-------------------------------------------------------------
+        # Configuration
+        #-------------------------------------------------------------
+
+        # initialization
+        def initialize(options={}, &block)
+          super options, &block
+        end
+
+        #-------------------------------------------------------------
+        # Public Methods
+        #-------------------------------------------------------------
+
+        #=============== DATA ACCESSORS =======================
+
+        def contents
+          @contents ||= []
+        end
+
+        #=============== VALIDATION ===========================
+
+        def valid?
+          contents.size > 0
+        end
+      end
+    end
+  end
+end

data/lib/caracal/core/models/page_flip_model.rb

@@ -0,0 +1,41 @@
+require 'caracal/core/models/base_model'
+
+module Caracal
+  module Core
+    module Models
+
+      # This class handles block options passed to tables via their data
+      # collections.
+      #
+      class PageFlipModel < BaseModel
+
+        #-------------------------------------------------------------
+        # Configuration
+        #-------------------------------------------------------------
+
+        # initialization
+        def initialize(options={}, &block)
+          super options, &block
+        end
+
+        #-------------------------------------------------------------
+        # Public Methods
+        #-------------------------------------------------------------
+
+        #=============== DATA ACCESSORS =======================
+
+        # .contents
+        def contents
+          @contents ||= []
+        end
+
+        #=============== VALIDATION ===========================
+
+        # .valid?
+        def valid?
+          contents.size > 0
+        end
+      end
+    end
+  end
+end

data/lib/caracal/core/models/paragraph_model.rb

@@ -2,6 +2,7 @@ require 'caracal/core/models/base_model'
 require 'caracal/core/models/bookmark_model'
 require 'caracal/core/models/link_model'
 require 'caracal/core/models/text_model'
+require 'caracal/core/models/field_model'
 require 'caracal/errors'
 
 
@@ -126,6 +127,20 @@ module Caracal
           model
         end
 
+        # .page_num
+        def field(*args, &block)
+          options = Caracal::Utilities.extract_options!(args)
+          options = options.merge({ type: args[0] })
+
+          model = Caracal::Core::Models::FieldModel.new(options, &block)
+          if model.valid?
+            runs << model
+          else
+            raise Caracal::Errors::InvalidModelError, ':page_num method must receive a string for the display text.'
+          end
+          model
+        end
+
         # .link
         def link(*args, &block)
           options = Caracal::Utilities.extract_options!(args)

data/lib/caracal/core/models/relationship_model.rb

@@ -18,6 +18,7 @@ module Caracal
         TYPE_MAP = {
           font:       'http://schemas.openxmlformats.org/officeDocument/2006/relationships/fontTable', 
           footer:     'http://schemas.openxmlformats.org/officeDocument/2006/relationships/footer',
+          header:     'http://schemas.openxmlformats.org/officeDocument/2006/relationships/header',
           image:      'http://schemas.openxmlformats.org/officeDocument/2006/relationships/image',
           link:       'http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink',
           numbering:  'http://schemas.openxmlformats.org/officeDocument/2006/relationships/numbering',

data/lib/caracal/core/models/style_model.rb

@@ -28,6 +28,7 @@ module Caracal
         const_set(:DEFAULT_STYLE_BOTTOM,     0)          # 0.0in  in twips
         const_set(:DEFAULT_STYLE_BASE,       'Normal')
         const_set(:DEFAULT_STYLE_NEXT,       'Normal')
+        const_set(:DEFAULT_STYLE_OUTLINE,    9)          # no level
 
         # accessors
         attr_reader :style_default
@@ -50,6 +51,7 @@ module Caracal
         attr_reader :style_indent_left
         attr_reader :style_indent_right
         attr_reader :style_indent_first
+        attr_reader :style_outline
 
         # initialization
         def initialize(options={}, &block)
@@ -72,6 +74,7 @@ module Caracal
             @style_top        ||= DEFAULT_STYLE_TOP
             @style_bottom     ||= DEFAULT_STYLE_BOTTOM
             @style_line       ||= DEFAULT_STYLE_LINE
+            @style_outline    ||= DEFAULT_STYLE_OUTLINE
           end
         end
 
@@ -97,7 +100,7 @@ module Caracal
         end
 
         # strings
-        [:id, :type, :name, :color, :font].each do |m|
+        [:id, :type, :name, :color, :font, :outline].each do |m|
           define_method "#{ m }" do |value|
             instance_variable_set("@style_#{ m }", value.to_s)
           end
@@ -155,7 +158,8 @@ module Caracal
             :align,
             :indent_left,
             :indent_right,
-            :indent_first ]
+            :indent_first,
+            :outline ]
         end
 
       end

data/lib/caracal/core/page_flips.rb

@@ -0,0 +1,34 @@
+require 'caracal/core/models/page_flip_model'
+require 'caracal/errors'
+
+
+module Caracal
+  module Core
+
+    # This module encapsulates all the functionality related to flipping
+    # specific page contents
+    #
+    module PageFlips
+      def self.included(base)
+        base.class_eval do
+
+          #-------------------------------------------------------------
+          # Public Methods
+          #-------------------------------------------------------------
+
+          def page_flip(*args, &block)
+            options = Caracal::Utilities.extract_options!(args)
+
+            model = Caracal::Core::Models::PageFlipModel.new(options, &block)
+            
+            if model.valid?
+              contents << model
+            end
+
+            model
+          end
+        end
+      end
+    end
+  end
+end

data/lib/caracal/core/relationships.rb

@@ -27,6 +27,7 @@ module Caracal
             [
               { target: 'fontTable.xml',  type: :font      },
               { target: 'footer1.xml',    type: :footer    },
+              { target: 'header1.xml',    type: :header    },
               { target: 'numbering.xml',  type: :numbering },
               { target: 'settings.xml',   type: :setting   },
               { target: 'styles.xml',     type: :style     }

data/lib/caracal/core/styles.rb

@@ -19,12 +19,12 @@ module Caracal
           def self.default_styles
             [
               { id: 'Normal',   name: 'normal',    font: 'Arial',    size: 20, line: 320, color: '333333' },
-              { id: 'Heading1', name: 'heading 1', font: 'Palatino', size: 36, bottom: 120 },
-              { id: 'Heading2', name: 'heading 2', font: 'Arial',    size: 26, top: 120, bottom: 160, bold: true },
-              { id: 'Heading3', name: 'heading 3', font: 'Arial',    size: 24, top: 120, bottom: 160, bold: true, italic: true, color: '666666' },
-              { id: 'Heading4', name: 'heading 4', font: 'Palatino', size: 24, top: 120, bottom: 120, bold: true },
-              { id: 'Heading5', name: 'heading 5', font: 'Arial',    size: 22, top: 120, bottom: 120, bold: true },
-              { id: 'Heading6', name: 'heading 6', font: 'Arial',    size: 22, top: 120, bottom: 120, underline: true, italic: true, color: '666666' },
+              { id: 'Heading1', name: 'heading 1', font: 'Palatino', size: 36, outline: 0, bottom: 120},
+              { id: 'Heading2', name: 'heading 2', font: 'Arial',    size: 26, outline: 1, top: 120, bottom: 160, bold: true },
+              { id: 'Heading3', name: 'heading 3', font: 'Arial',    size: 24, outline: 2, top: 120, bottom: 160, bold: true, italic: true, color: '666666' },
+              { id: 'Heading4', name: 'heading 4', font: 'Palatino', size: 24, outline: 3, top: 120, bottom: 120, bold: true },
+              { id: 'Heading5', name: 'heading 5', font: 'Arial',    size: 22, outline: 4, top: 120, bottom: 120, bold: true },
+              { id: 'Heading6', name: 'heading 6', font: 'Arial',    size: 22, outline: 5, top: 120, bottom: 120, underline: true, italic: true, color: '666666' },
               { id: 'Title',    name: 'title',     font: 'Palatino', size: 60 },
               { id: 'Subtitle', name: 'subtitle',  font: 'Arial',    size: 28, top: 60 }
             ]           
@@ -83,4 +83,4 @@ module Caracal
     end
     
   end
-end
+end

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,6 +15,7 @@ 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'
@@ -27,6 +31,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 +60,18 @@ 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::Text
 
+    include Caracal::Core::Footer
+    include Caracal::Core::Header
 
     #------------------------------------------------------
     # Public Class Methods
@@ -129,6 +138,13 @@ module Caracal
       @contents ||= []
     end
 
+    def footer_content
+      @footer_content
+    end
+
+    def header_content
+      @header_content
+    end
 
     #============ RENDERING ===============================
 
@@ -144,6 +160,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 +236,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' }