caracal_the_curve 1.4.1

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

@@ -0,0 +1,176 @@
+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 TableCellModel < BaseModel
+
+        #-------------------------------------------------------------
+        # Configuration
+        #-------------------------------------------------------------
+
+        # constants
+        const_set(:DEFAULT_CELL_BACKGROUND,       'ffffff')
+        const_set(:DEFAULT_CELL_MARGINS,          Caracal::Core::Models::MarginModel.new({ top: 100, bottom: 100, left: 100, right: 100 }))
+        const_set(:DEFAULT_CELL_VERTICAL_ALIGN,   :top)
+
+        # accessors
+        attr_reader :cell_background
+        attr_reader :cell_width
+        attr_reader :cell_margins
+        attr_reader :cell_vertical_align
+        attr_reader :cell_rowspan
+        attr_reader :cell_colspan
+
+        # initialization
+        def initialize(options={}, &block)
+          @cell_background      = DEFAULT_CELL_BACKGROUND
+          @cell_margins         = DEFAULT_CELL_MARGINS
+          @cell_vertical_align  = DEFAULT_CELL_VERTICAL_ALIGN
+
+          if content = options.delete(:content)
+            p content, options.dup, &block
+          end
+
+          super options, &block
+
+          p_klass = Caracal::Core::Models::ParagraphModel     # the final tag in a table cell
+          unless contents.last.is_a? p_klass                  # *must* be a paragraph for OOXML
+            contents << p_klass.new(content: '')              # to not throw an error.
+          end
+        end
+
+
+        #-------------------------------------------------------------
+        # Public Methods
+        #-------------------------------------------------------------
+
+        #=============== DATA ACCESSORS =======================
+
+        def contents
+          @contents ||= []
+        end
+
+
+        #=============== STYLES ===============================
+
+        # This method allows styles to be applied to this cell
+        # from the table level.  It attempts to add the style
+        # first to the instance, and then to any sub-models that
+        # respond to the method.
+        #
+        # In all cases, invalid options will simply be ignored.
+        #
+        def apply_styles(opts={})
+          # make dup of options so we don't
+          # harm args sent to sibling cells
+          options = opts.dup
+
+          # first, try apply to self
+          options.each do |(k,v)|
+            send(k, v)  if respond_to?(k)
+          end
+
+          # prevent top-level attrs from trickling down
+          options.delete_if { |(k,v)| option_keys.include?(k) }
+
+          # then, try apply to contents
+          contents.each do |model|
+            options.each do |k,v|
+              model.send(k, v) if model.respond_to?(k)
+            end
+
+            # finally, apply to runs. options do trickle down
+            # because paragraph-level styles don't seem to
+            # affect runs within tables. weirdsies.
+            if model.respond_to?(:runs)
+              model.runs.each do |run|
+                options.each do |k,v|
+                  run.send(k, v) if run.respond_to?(k)
+                end
+              end
+            end
+          end
+        end
+
+        def calculate_width(default_width)
+          width(default_width) unless cell_width.to_i > 0
+
+          container_width = cell_width - cell_margin_left - cell_margin_right
+
+          contents.each do |model|
+            if model.respond_to?(:calculate_width)
+              model.calculate_width(container_width)    # will always be a TableModel
+            end
+          end
+        end
+
+
+        #=============== GETTERS ==============================
+
+        # margin attrs
+        [:top, :bottom, :left, :right].each do |m|
+          define_method "cell_margin_#{ m }" do
+            v = cell_margins ? cell_margins.send("margin_#{ m }") : 0
+          end
+        end
+
+
+        #=============== SETTERS ==============================
+
+        # integers
+        [:width, :colspan, :rowspan].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@cell_#{ m }", value.to_i)
+          end
+        end
+
+        # models
+        [:margins].each do |m|
+          define_method "#{ m }" do |options = {}, &block|
+            instance_variable_set("@cell_#{ m }", Caracal::Core::Models::MarginModel.new(options, &block))
+          end
+        end
+
+        # strings
+        [:background].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@cell_#{ m }", value.to_s)
+          end
+        end
+
+        #symbols
+        [:vertical_align].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@cell_#{ m }", value.to_s.to_sym)
+          end
+        end
+
+        #=============== VALIDATION ===========================
+
+        def valid?
+          contents.size > 0
+        end
+
+
+        #-------------------------------------------------------------
+        # Private Instance Methods
+        #-------------------------------------------------------------
+        private
+
+        def option_keys
+          [:background, :margins, :width, :vertical_align, :rowspan, :colspan]
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,206 @@
+require 'caracal/core/models/base_model'
+require 'caracal/core/models/border_model'
+require 'caracal/core/models/table_cell_model'
+
+
+module Caracal
+  module Core
+    module Models
+      
+      # This class handles block options passed to the table
+      # method.
+      #
+      class TableModel < BaseModel
+        
+        #-------------------------------------------------------------
+        # Configuration
+        #-------------------------------------------------------------
+        
+        # constants
+        const_set(:DEFAULT_TABLE_ALIGN,             :center)    # weirdly, works better w/ full width
+        const_set(:DEFAULT_TABLE_BORDER_COLOR,      'auto')
+        const_set(:DEFAULT_TABLE_BORDER_LINE,       :single)
+        const_set(:DEFAULT_TABLE_BORDER_SIZE,       0)          # units in 1/8 points
+        const_set(:DEFAULT_TABLE_BORDER_SPACING,    0)          
+        
+        # accessors
+        attr_reader :table_align
+        attr_reader :table_width
+        attr_reader :table_border_color
+        attr_reader :table_border_line
+        attr_reader :table_border_size
+        attr_reader :table_border_spacing
+        attr_reader :table_border_top         # returns border model
+        attr_reader :table_border_bottom      # returns border model
+        attr_reader :table_border_left        # returns border model
+        attr_reader :table_border_right       # returns border model
+        attr_reader :table_border_horizontal  # returns border model
+        attr_reader :table_border_vertical    # returns border model
+        
+        # initialization
+        def initialize(options={}, &block)
+          @table_align          = DEFAULT_TABLE_ALIGN
+          @table_border_color   = DEFAULT_TABLE_BORDER_COLOR
+          @table_border_line    = DEFAULT_TABLE_BORDER_LINE
+          @table_border_size    = DEFAULT_TABLE_BORDER_SIZE
+          @table_border_spacing = DEFAULT_TABLE_BORDER_SPACING
+          
+          super options, &block
+        end
+        
+        
+        #-------------------------------------------------------------
+        # Public Methods
+        #-------------------------------------------------------------
+        
+        #=============== DATA ACCESSORS =======================
+        
+        def cells
+          rows.flatten
+        end
+        
+        def cols
+          rows.reduce([]) do |array, row|
+            row.each_with_index do |cell, index|
+              array[index]  = []    if array[index].nil?
+              array[index] << cell
+            end
+            array
+          end
+        end
+        
+        def rows
+          @table_data || [[]]
+        end
+        
+        
+        #=============== STYLES ===============================
+        
+        # This method sets explicit widths on all wrapped cells
+        # that do not already have widths asided.
+        #
+        def calculate_width(container_width)
+          width(container_width) unless table_width.to_i > 0
+          
+          cells.each { |c| c.calculate_width(default_cell_width) }
+        end
+        
+        # This method allows tables to be styled several cells 
+        # at a time.
+        #
+        # For example, this would style a header row.
+        #
+        # docx.table data do |t|
+        #   t.cell_style t.rows[0], background: '3366cc', color: 'ffffff', bold: true
+        # end
+        #
+        def cell_style(models, options={})
+          [models].flatten.compact.each do |m|
+            m.apply_styles(options)
+          end  
+        end
+        
+        
+        #=============== GETTERS ==============================
+        
+        # border attrs
+        [:top, :bottom, :left, :right, :horizontal, :vertical].each do |m|
+          [:color, :line, :size, :spacing].each do |attr|
+            define_method "table_border_#{ m }_#{ attr }" do
+              model = send("table_border_#{ m }")
+              value = (model) ? model.send("border_#{ attr }") : send("table_border_#{ attr }")
+            end
+          end
+          define_method "table_border_#{ m }_total_size" do
+            model = send("table_border_#{ m }")
+            value = (model) ? model.total_size : table_border_size + (2 * table_border_spacing)
+          end
+        end
+        
+        
+        #=============== SETTERS ==============================
+        
+        # integers
+        [:border_size, :border_spacing, :width].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@table_#{ m }", value.to_i)
+          end
+        end
+        
+        # models
+        [:top, :bottom, :left, :right, :horizontal, :vertical].each do |m|
+          define_method "border_#{ m }" do |options = {}, &block|
+            options.merge!({ type: m })
+            instance_variable_set("@table_border_#{ m }", Caracal::Core::Models::BorderModel.new(options, &block))
+          end
+        end
+        
+        # strings
+        [:border_color].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@table_#{ m }", value.to_s)
+          end
+        end
+        
+        # symbols
+        [:border_line, :align].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@table_#{ m }", value.to_s.to_sym)
+          end
+        end
+        
+        # .data
+        def data(value)
+          begin
+            @table_data = value.map do |data_row|
+              data_row.map do |data_cell|
+                case data_cell
+                when Caracal::Core::Models::TableCellModel
+                  data_cell
+                when Hash
+                  Caracal::Core::Models::TableCellModel.new(data_cell)
+                when Proc
+                  Caracal::Core::Models::TableCellModel.new(&data_cell)
+                else
+                  Caracal::Core::Models::TableCellModel.new({ content: data_cell.to_s })
+                end
+              end
+            end
+          rescue
+            raise Caracal::Errors::InvalidTableDataError, 'Table data must be a two-dimensional array.'
+          end
+        end        
+        
+        
+        #=============== VALIDATION ==============================
+        
+        def valid?
+          cells.first.is_a?(Caracal::Core::Models::TableCellModel)
+        end
+        
+        
+        #-------------------------------------------------------------
+        # Private Instance Methods
+        #-------------------------------------------------------------
+        private
+        
+        def default_cell_width
+          cell_widths     = rows.first.map { |c| c.cell_width.to_i }
+          remaining_width = table_width - cell_widths.reduce(&:+).to_i
+          remaining_cols  = cols.size - cell_widths.reject { |w| w == 0 }.size
+          default_width   = (remaining_cols == 0) ? 0 : (remaining_width / remaining_cols)
+        end
+        
+        def option_keys
+          k = []
+          k << [:data, :align, :width]
+          k << [:border_color, :border_line, :border_size, :border_spacing]
+          k << [:border_bottom, :border_left, :border_right, :border_top, :border_horizontal, :border_vertical]
+          k.flatten
+        end
+        
+      end
+      
+    end
+  end
+end

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

@@ -0,0 +1,118 @@
+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 TextModel < BaseModel
+
+        #--------------------------------------------------
+        # Configuration
+        #--------------------------------------------------
+
+        # accessors
+        attr_reader :text_content
+        attr_reader :text_style
+        attr_reader :text_font
+        attr_reader :text_color
+        attr_reader :text_size
+        attr_reader :text_bold
+        attr_reader :text_italic
+        attr_reader :text_underline
+        attr_reader :text_bgcolor
+        attr_reader :text_highlight_color
+        attr_reader :text_vertical_align
+
+
+
+        #--------------------------------------------------
+        # Public Methods
+        #--------------------------------------------------
+
+        #========== GETTERS ===============================
+
+        # .run_attributes
+        def run_attributes
+          {
+            style:            text_style,
+            font:             text_font,
+            color:            text_color,
+            size:             text_size,
+            bold:             text_bold,
+            italic:           text_italic,
+            underline:        text_underline,
+            bgcolor:          text_bgcolor,
+            highlight_color:  text_highlight_color,
+            vertical_align:   text_vertical_align
+          }
+        end
+
+
+        #========== SETTERS ===============================
+
+        # booleans
+        [:bold, :italic, :underline].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@text_#{ m }", !!value)
+          end
+        end
+
+        # integers
+        [:size].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@text_#{ m }", value.to_i)
+          end
+        end
+
+        # strings
+        [:bgcolor, :color, :content, :font, :highlight_color, :style].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@text_#{ m }", value.to_s)
+          end
+        end
+
+        # symbols
+        [:vertical_align].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@text_#{ m }", value.to_s.to_sym)
+          end
+        end
+
+
+        #========== VALIDATION ============================
+
+        def valid?
+          a = [:content]
+          a.map { |m| send("text_#{ m }") }.compact.size == a.size
+        end
+
+
+        #--------------------------------------------------
+        # Private Methods
+        #--------------------------------------------------
+        private
+
+        def option_keys
+          [:content, :style, :font, :color, :size, :bold, :italic, :underline, :bgcolor, :highlight_color, :vertical_align]
+        end
+
+        def method_missing(method, *args, &block)
+          # I'm on the fence with respect to this implementation. We're ignoring
+          # :method_missing errors to allow syntax flexibility for paragraph-type
+          # models.  The issue is the syntax format of those models--the way we pass
+          # the content value as a special argument--coupled with the model's
+          # ability to accept nested instructions.
+          #
+          # By ignoring method missing errors here, we can pass the entire paragraph
+          # block in the initial, built-in call to :text.
+        end
+
+      end
+
+    end
+  end
+end

data/lib/caracal/core/namespaces.rb

@@ -0,0 +1,89 @@
+require 'caracal/core/models/namespace_model'
+require 'caracal/errors'
+
+
+module Caracal
+  module Core
+
+    # This module encapsulates all the functionality related to registering and
+    # retrieving namespaces.
+    #
+    module Namespaces
+      def self.included(base)
+        base.class_eval do
+
+          #-------------------------------------------------------------
+          # Class Methods
+          #-------------------------------------------------------------
+
+          def self.default_namespaces
+            [
+              { prefix: 'xmlns:mc',   href: 'http://schemas.openxmlformats.org/markup-compatibility/2006'             },
+              { prefix: 'xmlns:o',    href: 'urn:schemas-microsoft-com:office:office'                                 },
+              { prefix: 'xmlns:r',    href: 'http://schemas.openxmlformats.org/officeDocument/2006/relationships'     },
+              { prefix: 'xmlns:m',    href: 'http://schemas.openxmlformats.org/officeDocument/2006/math'              },
+              { prefix: 'xmlns:v',    href: 'urn:schemas-microsoft-com:vml'                                           },
+              { prefix: 'xmlns:wp',   href: 'http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing'  },
+              { prefix: 'xmlns:w10',  href: 'urn:schemas-microsoft-com:office:word'                                   },
+              { prefix: 'xmlns:w',    href: 'http://schemas.openxmlformats.org/wordprocessingml/2006/main'            },
+              { prefix: 'xmlns:wne',  href: 'http://schemas.microsoft.com/office/word/2006/wordml'                    },
+              { prefix: 'xmlns:sl',   href: 'http://schemas.openxmlformats.org/schemaLibrary/2006/main'               },
+              { prefix: 'xmlns:a',    href: 'http://schemas.openxmlformats.org/drawingml/2006/main'                   },
+              { prefix: 'xmlns:pic',  href: 'http://schemas.openxmlformats.org/drawingml/2006/picture'                },
+              { prefix: 'xmlns:c',    href: 'http://schemas.openxmlformats.org/drawingml/2006/chart'                  },
+              { prefix: 'xmlns:lc',   href: 'http://schemas.openxmlformats.org/drawingml/2006/lockedCanvas'           },
+              { prefix: 'xmlns:dgm',  href: 'http://schemas.openxmlformats.org/drawingml/2006/diagram'                }
+            ]
+          end
+
+
+          #-------------------------------------------------------------
+          # Public Methods
+          #-------------------------------------------------------------
+
+          #============== ATTRIBUTES ==========================
+
+          def namespace(options={}, &block)
+            model = Caracal::Core::Models::NamespaceModel.new(options, &block)
+            if model.valid?
+              ns = register_namespace(model)
+            else
+              raise Caracal::Errors::InvalidModelError, 'namespace must specify the :prefix and :href attributes.'
+            end
+            ns
+          end
+
+
+          #============== GETTERS =============================
+
+          def namespaces
+            @namespaces ||= []
+          end
+
+          def find_namespace(prefix)
+            namespaces.find { |ns| ns.matches?(prefix) }
+          end
+
+
+          #============== REGISTRATION ========================
+
+          def register_namespace(model)
+            unless ns = find_namespace(model.namespace_prefix)
+              namespaces << model
+              ns = model
+            end
+            ns
+          end
+
+          def unregister_namespace(prefix)
+            if ns = find_namespace(prefix)
+              namespaces.delete(ns)
+            end
+          end
+
+        end
+      end
+    end
+
+  end
+end

data/lib/caracal/core/page_breaks.rb

@@ -0,0 +1,29 @@
+require 'caracal/core/models/page_break_model'
+
+
+module Caracal
+  module Core
+    
+    # This module encapsulates all the functionality related to adding page
+    # breaks to the document.
+    #
+    module PageBreaks
+      def self.included(base)
+        base.class_eval do
+          
+          #-------------------------------------------------------------
+          # Public Methods
+          #-------------------------------------------------------------
+          
+          def page
+            model     = Caracal::Core::Models::PageBreakModel.new()
+            contents << model
+            model
+          end
+          
+        end
+      end
+    end
+    
+  end
+end

data/lib/caracal/core/page_numbers.rb

@@ -0,0 +1,58 @@
+require 'caracal/core/models/page_number_model'
+require 'caracal/errors'
+
+
+module Caracal
+  module Core
+
+    # This module encapsulates all the functionality related to setting the
+    # document's page number behavior.
+    #
+    module PageNumbers
+      def self.included(base)
+        base.class_eval do
+
+          #-------------------------------------------------------------
+          # Configuration
+          #-------------------------------------------------------------
+
+          # constants
+          const_set(:DEFAULT_PAGE_NUMBER_ALIGN,  :center)
+
+          # accessors
+          attr_reader :page_number_align
+          attr_reader :page_number_label
+          attr_reader :page_number_label_size
+          attr_reader :page_number_number_size
+          attr_reader :page_number_show
+
+
+          #-------------------------------------------------------------
+          # Public Methods
+          #-------------------------------------------------------------
+
+          # This method controls whether and how page numbers are displayed
+          # on the document.
+          #
+          def page_numbers(*args, &block)
+            options = Caracal::Utilities.extract_options!(args)
+            options.merge!({ show: !!args.first }) unless args.first.nil?  # careful: just `args.first` is falsey
+
+            model = Caracal::Core::Models::PageNumberModel.new(options, &block)
+            if model.valid?
+              @page_number_align        = model.page_number_align
+              @page_number_label        = model.page_number_label
+              @page_number_label_size   = model.page_number_label_size
+              @page_number_number_size  = model.page_number_number_size
+              @page_number_show         = model.page_number_show
+            else
+              raise Caracal::Errors::InvalidModelError, 'page_numbers :align parameter must be :left, :center, or :right'
+            end
+          end
+
+        end
+      end
+    end
+
+  end
+end