caracal 0.1.0

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

@@ -0,0 +1,120 @@
+require 'caracal/core/models/base_model'
+
+
+module Caracal
+  module Core
+    module Models
+      
+      # This class handles block options passed to the page margins
+      # method.
+      #
+      class BorderModel < BaseModel
+        
+        #-------------------------------------------------------------
+        # Configuration
+        #-------------------------------------------------------------
+        
+        # constants
+        const_set(:DEFAULT_BORDER_COLOR,    'auto')
+        const_set(:DEFAULT_BORDER_LINE,     :single) 
+        const_set(:DEFAULT_BORDER_SIZE,     4)        # 0.5pt in 1/8 points
+        const_set(:DEFAULT_BORDER_SPACING,  1)        # 0.125pt in 1/8 points
+        const_set(:DEFAULT_BORDER_TYPE,     :top)
+        
+        # accessors
+        attr_reader :border_color
+        attr_reader :border_line
+        attr_reader :border_size
+        attr_reader :border_spacing
+        attr_reader :border_type
+        
+        # initialization
+        def initialize(**options, &block)
+          @border_color   = DEFAULT_BORDER_COLOR
+          @border_line    = DEFAULT_BORDER_LINE
+          @border_size    = DEFAULT_BORDER_SIZE
+          @border_spacing = DEFAULT_BORDER_SPACING
+          @border_type    = DEFAULT_BORDER_TYPE
+          
+          super options, &block
+        end
+        
+        
+        #-------------------------------------------------------------
+        # Class Methods
+        #-------------------------------------------------------------
+        
+        def self.formatted_type(type)
+          case type.to_s.to_sym
+          when :horizontal  then 'insideH'
+          when :vertical    then 'insideV'
+          when :top         then 'top'
+          when :bottom      then 'bottom'
+          when :left        then 'left'
+          when :right       then 'right'
+          else nil
+          end
+        end
+        
+        
+        #-------------------------------------------------------------
+        # Public Methods
+        #-------------------------------------------------------------
+        
+        #=============== GETTERS ==============================
+        
+        def formatted_type
+          self.class.formatted_type(border_type)
+        end
+        
+        def total_size
+          border_size + (2 * border_spacing)
+        end
+        
+        
+        #=============== SETTERS ==============================
+        
+        # integers
+        [:size, :spacing].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@border_#{ m }", value.to_i)
+          end
+        end
+        
+        # strings
+        [:color].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@border_#{ m }", value.to_s)
+          end
+        end
+        
+        # symbols
+        [:line, :type].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@border_#{ m }", value.to_s.to_sym)
+          end
+        end
+        
+        
+        #=============== VALIDATION ==============================
+        
+        def valid?
+          dims = [border_size, border_spacing]
+          dims.all? { |d| d > 0 }
+        end
+        
+        
+        #-------------------------------------------------------------
+        # Private Instance Methods
+        #-------------------------------------------------------------
+        private
+        
+        def option_keys
+          [:color, :line, :size, :spacing, :type]
+        end
+        
+      end
+      
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+require 'caracal/core/models/base_model'
+
+
+module Caracal
+  module Core
+    module Models
+      
+      # This class encapsulates the logic needed to store and manipulate
+      # font data.
+      #
+      class FontModel < BaseModel
+        
+        #-------------------------------------------------------------
+        # Configuration
+        #-------------------------------------------------------------
+        
+        # accessors
+        attr_reader :font_name
+        
+        
+        
+        #-------------------------------------------------------------
+        # Public Instance Methods
+        #-------------------------------------------------------------
+    
+        #=============== SETTERS ==============================
+        
+        # strings
+        [:name].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@font_#{ m }", value.to_s)
+          end
+        end
+        
+        
+        #=============== STATE ================================
+        
+        def matches?(str)
+          font_name.to_s.downcase == str.to_s.downcase
+        end
+        
+        
+        #=============== VALIDATION ===========================
+        
+        def valid?
+          a = [:name]
+          a.map { |m| send("font_#{ m }") }.compact.size == a.size
+        end
+        
+        
+        #-------------------------------------------------------------
+        # Private Instance Methods
+        #-------------------------------------------------------------
+        private
+        
+        def option_keys
+          [:name]
+        end
+        
+      end
+      
+    end
+  end
+end

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

@@ -0,0 +1,118 @@
+require 'caracal/core/models/base_model'
+
+
+module Caracal
+  module Core
+    module Models
+      
+      # This class handles block options passed to the img method.
+      #
+      class ImageModel < BaseModel
+        
+        #-------------------------------------------------------------
+        # Configuration
+        #-------------------------------------------------------------
+        
+        # constants
+        const_set(:DEFAULT_IMAGE_WIDTH,   0)        # units in pixels. (will cause error)
+        const_set(:DEFAULT_IMAGE_HEIGHT,  0)        # units in pixels. (will cause error)
+        const_set(:DEFAULT_IMAGE_ALIGN,   :left) 
+        const_set(:DEFAULT_IMAGE_TOP,     8)        # units in pixels. 
+        const_set(:DEFAULT_IMAGE_BOTTOM,  8)        # units in pixels. 
+        const_set(:DEFAULT_IMAGE_LEFT,    8)        # units in pixels. 
+        const_set(:DEFAULT_IMAGE_RIGHT,   8)        # units in pixels. 
+        
+        # accessors
+        attr_reader :image_url
+        attr_reader :image_width
+        attr_reader :image_height
+        attr_reader :image_align
+        attr_reader :image_top
+        attr_reader :image_bottom
+        attr_reader :image_left
+        attr_reader :image_right
+        
+        
+        # initialization
+        def initialize(**options, &block)
+          @image_width  = DEFAULT_IMAGE_WIDTH
+          @image_height = DEFAULT_IMAGE_HEIGHT
+          @image_align  = DEFAULT_IMAGE_ALIGN
+          @image_top    = DEFAULT_IMAGE_TOP
+          @image_bottom = DEFAULT_IMAGE_BOTTOM
+          @image_left   = DEFAULT_IMAGE_LEFT
+          @image_right  = DEFAULT_IMAGE_RIGHT
+          
+          super options, &block
+        end
+        
+        
+        #-------------------------------------------------------------
+        # Public Methods
+        #-------------------------------------------------------------
+        
+        #=============== GETTERS ==============================
+        
+        [:width, :height, :top, :bottom, :left, :right].each do |m|
+          define_method "formatted_#{ m }" do
+            value = send("image_#{ m }")
+            pixels_to_emus(value)
+          end
+        end
+        
+        
+        #=============== SETTERS ==============================
+        
+        # integers
+        [:width, :height, :top, :bottom, :left, :right].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@image_#{ m }", value.to_i)
+          end
+        end
+        
+        # strings
+        [:url].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@image_#{ m }", value.to_s)
+          end
+        end
+        
+        # symbols
+        [:align].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@image_#{ m }", value.to_s.to_sym)
+          end
+        end        
+        
+        
+        #=============== VALIDATION ==============================
+        
+        def valid?
+          dims = [:width, :height, :top, :bottom, :left, :right].map { |m| send("image_#{ m }") }
+          dims.all? { |d| d > 0 }
+        end
+        
+        
+        
+        #-------------------------------------------------------------
+        # Private Methods
+        #-------------------------------------------------------------
+        private
+        
+        def option_keys
+          [:url, :width, :height, :align, :top, :bottom, :left, :right]
+        end
+        
+        def pixels_to_emus(value)
+          pixels        = value.to_i
+          inches        = pixels / 72.0
+          emus_per_inch = 914400
+        
+          emus = (inches * emus_per_inch).to_i 
+        end
+        
+      end
+      
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+require 'caracal/core/models/base_model'
+
+
+module Caracal
+  module Core
+    module Models
+      
+      # This class encapsulates the logic needed to store and manipulate
+      # line break data.
+      #
+      class LineBreakModel < BaseModel; end
+      
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+require 'caracal/core/models/text_model'
+
+
+module Caracal
+  module Core
+    module Models
+      
+      # This class encapsulates the logic needed to store and manipulate
+      # link data.
+      #
+      class LinkModel < TextModel
+        
+        #-------------------------------------------------------------
+        # Configuration
+        #-------------------------------------------------------------
+        
+        # readers (create aliases for superclass methods to conform 
+        # to expected naming convention.)
+        attr_reader  :link_href
+        alias_method :link_content,   :text_content
+        alias_method :link_style,     :text_style
+        alias_method :link_color,     :text_color
+        alias_method :link_size,      :text_size
+        alias_method :link_bold,      :text_bold
+        alias_method :link_italic,    :text_italic
+        alias_method :link_underline, :text_underline
+        
+        
+        
+        #-------------------------------------------------------------
+        # Public Instance Methods
+        #-------------------------------------------------------------
+    
+        #=============== SETTERS ==============================
+        
+        # strings
+        [:href].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@link_#{ m }", value.to_s)
+          end
+        end
+        
+        
+        #=============== VALIDATION ===========================
+        
+        def valid?
+          a = [:content, :href]
+          a.map { |m| send("link_#{ m }") }.compact.size == a.size
+        end
+        
+        
+        #-------------------------------------------------------------
+        # Private Instance Methods
+        #-------------------------------------------------------------
+        private
+        
+        def option_keys
+          (super + [:href]).flatten
+        end
+        
+      end
+      
+    end
+  end
+end

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

@@ -0,0 +1,105 @@
+require 'caracal/core/models/list_model'
+require 'caracal/core/models/paragraph_model'
+require 'caracal/errors'
+
+
+module Caracal
+  module Core
+    module Models
+      
+      # This class encapsulates the logic needed to store and manipulate
+      # list item data.
+      #
+      class ListItemModel < ParagraphModel
+        
+        #-------------------------------------------------------------
+        # Configuration
+        #-------------------------------------------------------------
+        
+        # accessors
+        attr_accessor :nested_list
+        
+        # readers (create aliases for superclass methods to conform 
+        # to expected naming convention.)
+        attr_reader  :list_item_type
+        attr_reader  :list_item_level
+        alias_method :list_item_style,     :paragraph_style
+        alias_method :list_item_color,     :paragraph_color
+        alias_method :list_item_size,      :paragraph_size
+        alias_method :list_item_bold,      :paragraph_bold
+        alias_method :list_item_italic,    :paragraph_italic
+        alias_method :list_item_underline, :paragraph_underline
+        
+        
+        
+        #-------------------------------------------------------------
+        # Public Instance Methods
+        #-------------------------------------------------------------
+        
+        #=============== SETTERS ==============================
+        
+        # integers
+        [:level].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@list_item_#{ m }", value.to_i)
+          end
+        end
+
+        # symbols
+        [:type].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@list_item_#{ m }", value.to_s.to_sym)
+          end
+        end
+        
+        
+        #=============== SUB-METHODS ===========================
+        
+        # .ol
+        def ol(**options, &block)
+          options.merge!({ type: :ordered, level: list_item_level + 1 })
+          
+          model = Caracal::Core::Models::ListModel.new(options, &block)
+          if model.valid?
+            @nested_list = model
+          else
+            raise Caracal::Errors::InvalidModelError, 'Ordered lists require at least one list item.'
+          end
+        end
+        
+        # .ul
+        def ul(**options, &block)
+          options.merge!({ type: :unordered, level: list_item_level + 1 })
+          
+          model = Caracal::Core::Models::ListModel.new(options, &block)
+          if model.valid?
+            @nested_list = model
+          else
+            raise Caracal::Errors::InvalidModelError, 'Unordered lists require at least one list item.'
+          end
+        end
+        
+        
+        #=============== VALIDATION ===========================
+        
+        def valid?
+          a = [:type, :level]
+          required = a.map { |m| send("list_item_#{ m }") }.compact.size == a.size
+          required && !runs.empty?
+        end
+        
+        
+        #-------------------------------------------------------------
+        # Private Instance Methods
+        #-------------------------------------------------------------
+        private
+        
+        def option_keys
+          [:type, :level, :content, :style, :color, :size, :bold, :italic, :underline]
+        end
+        
+      end
+      
+    end
+  end
+end