caracal 0.1.0

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

@@ -0,0 +1,141 @@
+require 'caracal/core/models/base_model'
+require 'caracal/core/models/link_model'
+require 'caracal/core/models/text_model'
+require 'caracal/errors'
+
+
+module Caracal
+  module Core
+    module Models
+      
+      # This class encapsulates the logic needed to store and manipulate
+      # paragraph data.
+      #
+      class ParagraphModel < BaseModel
+        
+        #-------------------------------------------------------------
+        # Configuration
+        #-------------------------------------------------------------
+        
+        # readers
+        attr_reader :paragraph_style
+        attr_reader :paragraph_align
+        attr_reader :paragraph_color
+        attr_reader :paragraph_size
+        attr_reader :paragraph_bold
+        attr_reader :paragraph_italic
+        attr_reader :paragraph_underline
+        
+        # initialization
+        def initialize(**options, &block)
+          if content = options.delete(:content)
+            text content, options.dup
+          end
+          
+          super options, &block
+        end
+        
+        
+        #-------------------------------------------------------------
+        # Public Instance Methods
+        #-------------------------------------------------------------
+    
+        #=============== GETTERS ==============================
+        
+        # .runs
+        def runs
+          @runs ||= []
+        end
+        
+        # .run_attributes
+        def run_attributes
+          {
+            color:      paragraph_color,
+            size:       paragraph_size,
+            bold:       paragraph_bold,
+            italic:     paragraph_italic,
+            underline:  paragraph_underline,
+          }
+        end
+        
+        
+        #=============== SETTERS ==============================
+        
+        # booleans
+        [:bold, :italic, :underline].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@paragraph_#{ m }", !!value)
+          end
+        end
+        
+        # integers
+        [:size].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@paragraph_#{ m }", value.to_i)
+          end
+        end
+        
+        # strings
+        [:color, :style].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@paragraph_#{ m }", value.to_s)
+          end
+        end
+        
+        # symbols
+        [:align].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@paragraph_#{ m }", value.to_s.to_sym)
+          end
+        end
+        
+        
+        #=============== SUB-METHODS ===========================
+        
+        # .link
+        def link(*args, **options, &block)
+          options.merge!({ content: args[0] }) unless args[0].nil?
+          options.merge!({ href:    args[1] }) unless args[1].nil?
+          
+          model = Caracal::Core::Models::LinkModel.new(options, &block)
+          if model.valid?
+            runs << model
+          else
+            raise Caracal::Errors::InvalidModelError, ':link method must receive strings for the display text and the external href.'
+          end
+        end
+        
+        # .text
+        def text(*args, **options, &block)
+          options.merge!({ content: args[0] }) unless args[0].nil?
+          
+          model = Caracal::Core::Models::TextModel.new(options, &block)
+          if model.valid?
+            runs << model
+          else
+            raise Caracal::Errors::InvalidModelError, ':text method must receive a string for the display text.'
+          end
+        end
+        
+        
+        #=============== VALIDATION ===========================
+        
+        def valid?
+          runs.size > 0
+        end
+        
+        
+        #-------------------------------------------------------------
+        # Private Instance Methods
+        #-------------------------------------------------------------
+        private
+        
+        def option_keys
+          [:content, :style, :align, :color, :size, :bold, :italic, :underline]
+        end
+        
+      end
+      
+    end
+  end
+end

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

@@ -0,0 +1,108 @@
+require 'caracal/core/models/base_model'
+
+
+module Caracal
+  module Core
+    module Models
+      
+      # This class encapsulates the logic needed to store and manipulate
+      # relationship data.
+      #
+      class RelationshipModel < BaseModel
+        
+        #-------------------------------------------------------------
+        # Configuration
+        #-------------------------------------------------------------
+    
+        # constants
+        TYPE_MAP = {
+          font:       'http://schemas.openxmlformats.org/officeDocument/2006/relationships/fontTable', 
+          footer:     'http://schemas.openxmlformats.org/officeDocument/2006/relationships/footer',
+          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',
+          setting:    'http://schemas.openxmlformats.org/officeDocument/2006/relationships/settings',
+          style:      'http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles'
+        }
+        
+        # accessors
+        attr_reader :relationship_id
+        attr_reader :relationship_type
+        attr_reader :relationship_target
+        attr_reader :relationship_key
+        
+        
+        
+        #-------------------------------------------------------------
+        # Public Instance Methods
+        #-------------------------------------------------------------
+    
+        #=================== GETTERS =============================
+        
+        def formatted_id
+          "rId#{ relationship_id }"
+        end
+        
+        def formatted_target
+          if relationship_type == :image
+            ext = relationship_target.to_s.split('.').last
+            "media/image#{ relationship_id }.#{ ext }"
+          else
+            relationship_target
+          end
+        end
+        
+        def formatted_type
+          TYPE_MAP.fetch(relationship_type)
+        end
+        
+        
+        #=================== SETTERS =============================
+        
+        def id(value)
+          @relationship_id = value.to_i
+        end
+        
+        def target(value)
+          @relationship_target = value.to_s
+          @relationship_key    = value.to_s.downcase
+        end
+        
+        def type(value)
+          @relationship_type = value.to_s.downcase.to_sym
+        end
+        
+        
+        #=================== STATE ===============================
+        
+        def matches?(str)
+          relationship_key.downcase == str.to_s.downcase
+        end
+        
+        def target_mode?
+          relationship_type == :link
+        end
+        
+        
+        #=============== VALIDATION ===========================
+        
+        def valid?
+          required = [:id, :target, :type]
+          required.all? { |m| !send("relationship_#{ m }").nil? }
+        end
+        
+        
+        #-------------------------------------------------------------
+        # Private Instance Methods
+        #-------------------------------------------------------------
+        private
+        
+        def option_keys
+          [:id, :type, :target]
+        end
+        
+      end
+      
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+require 'caracal/core/models/border_model'
+
+
+module Caracal
+  module Core
+    module Models
+      
+      # This class handles block options passed to the page margins
+      # method.
+      #
+      class RuleModel < BorderModel
+        
+        #-------------------------------------------------------------
+        # Configuration
+        #-------------------------------------------------------------
+        
+        # aliases
+        alias_method :rule_color,    :border_color
+        alias_method :rule_size,     :border_size
+        alias_method :rule_spacing,  :border_spacing
+        alias_method :rule_line,     :border_line
+        
+      end
+      
+    end
+  end
+end

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

@@ -0,0 +1,134 @@
+require 'caracal/core/models/base_model'
+
+
+module Caracal
+  module Core
+    module Models
+      
+      # This class encapsulates the logic needed to store and manipulate
+      # paragraph style data.
+      #
+      class StyleModel < BaseModel
+        
+        #-------------------------------------------------------------
+        # Configuration
+        #-------------------------------------------------------------
+        
+        # constants
+        const_set(:DEFAULT_STYLE_COLOR,      '333333')
+        const_set(:DEFAULT_STYLE_SIZE,       20)
+        const_set(:DEFAULT_STYLE_BOLD,       false)
+        const_set(:DEFAULT_STYLE_ITALIC,     false)
+        const_set(:DEFAULT_STYLE_UNDERLINE,  false)
+        const_set(:DEFAULT_STYLE_ALIGN,      :left)
+        const_set(:DEFAULT_STYLE_LINE,       360)        # 0.25in in twips
+        const_set(:DEFAULT_STYLE_TOP,        0)          # 0.0in  in twips
+        const_set(:DEFAULT_STYLE_BOTTOM,     0)          # 0.0in  in twips
+        const_set(:DEFAULT_STYLE_BASE,       'Normal')
+        const_set(:DEFAULT_STYLE_NEXT,       'Normal')
+        
+        # accessors
+        attr_reader :style_default
+        attr_reader :style_id
+        attr_reader :style_name
+        attr_reader :style_color
+        attr_reader :style_font
+        attr_reader :style_size
+        attr_reader :style_bold
+        attr_reader :style_italic
+        attr_reader :style_underline
+        attr_reader :style_align
+        attr_reader :style_top
+        attr_reader :style_bottom
+        attr_reader :style_line
+        attr_reader :style_base
+        attr_reader :style_next
+    
+        
+        # initialization
+        def initialize(**options, &block)
+          @style_default = false
+          @style_base    = DEFAULT_STYLE_BASE
+          @style_next    = DEFAULT_STYLE_NEXT
+          
+          super options, &block
+          
+          if (style_id == DEFAULT_STYLE_BASE)
+            @style_default    ||= true
+            @style_color      ||= DEFAULT_STYLE_COLOR
+            @style_size       ||= DEFAULT_STYLE_SIZE
+            @style_bold       ||= DEFAULT_STYLE_BOLD
+            @style_italic     ||= DEFAULT_STYLE_ITALIC
+            @style_underline  ||= DEFAULT_STYLE_UNDERLINE
+            @style_align      ||= DEFAULT_STYLE_ALIGN
+            @style_top        ||= DEFAULT_STYLE_TOP
+            @style_bottom     ||= DEFAULT_STYLE_BOTTOM
+            @style_line       ||= DEFAULT_STYLE_LINE
+          end
+        end
+        
+        
+        #-------------------------------------------------------------
+        # Public Instance Methods
+        #-------------------------------------------------------------
+    
+        #=============== SETTERS ==============================
+        
+        # booleans
+        [:bold, :italic, :underline].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@style_#{ m }", !!value)
+          end
+        end
+        
+        # integers
+        [:bottom, :size, :line, :top].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@style_#{ m }", value.to_i)
+          end
+        end
+        
+        # strings
+        [:id, :name, :color, :font].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@style_#{ m }", value.to_s)
+          end
+        end
+        
+        # symbols
+        [:align].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@style_#{ m }", value.to_s.to_sym)
+          end
+        end
+        
+        
+        #=============== STATE ================================
+        
+        def matches?(str)
+          style_id.downcase == str.to_s.downcase
+        end
+        
+        
+        #=============== VALIDATION ===========================
+        
+        def valid?
+          a = [:id, :name]
+          a.map { |m| send("style_#{ m }") }.compact.size == a.size
+        end
+        
+        
+        #-------------------------------------------------------------
+        # Private Instance Methods
+        #-------------------------------------------------------------
+        private
+        
+        def option_keys
+          [:bold, :italic, :underline, :top, :bottom, :size, :line, :id, :name, :color, :font, :align]
+        end
+        
+      end
+      
+    end
+  end
+end

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

@@ -0,0 +1,155 @@
+require 'caracal/core/models/base_model'
+require 'caracal/core/models/margin_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 }))
+        
+        # accessors
+        attr_reader :cell_background 
+        attr_reader :cell_width
+        attr_reader :cell_margins
+        
+        # initialization
+        def initialize(**options, &block)
+          @cell_background = DEFAULT_CELL_BACKGROUND
+          @cell_margins    = DEFAULT_CELL_MARGINS
+          
+          if content = options.delete(:content)
+            p content, options.dup
+          end
+          
+          super options, &block
+        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(**options)
+          # 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].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
+        
+        
+        #=============== VALIDATION ===========================
+        
+        def valid?
+          contents.size > 0
+        end
+        
+        
+        #-------------------------------------------------------------
+        # Private Instance Methods
+        #-------------------------------------------------------------
+        private
+        
+        def option_keys
+          [:background, :margins, :width]
+        end
+        
+      end
+      
+    end
+  end
+end