caracal_the_curve 1.4.1

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/custom_property_model.rb

@@ -0,0 +1,60 @@
+require 'caracal/core/models/base_model'
+
+
+module Caracal
+  module Core
+    module Models
+
+      # This class encapsulates the logic needed to store and manipulate
+      # custom properties
+      #
+      class CustomPropertyModel < BaseModel
+
+        # accessors
+        attr_reader :custom_property_name
+        attr_reader :custom_property_value
+        attr_reader :custom_property_type
+
+
+        #-------------------------------------------------------------
+        # Public Instance Methods
+        #-------------------------------------------------------------
+
+
+        #=================== SETTERS =============================
+
+        def name(value)
+          @custom_property_name = value.to_s
+        end
+
+        def value(value)
+          @custom_property_value = value.to_s
+        end
+
+        def type(value)
+          @custom_property_type = value.to_s
+        end
+
+
+        #=============== VALIDATION ===========================
+
+        def valid?
+          required = option_keys
+          required.all? { |m| !send("custom_property_#{ m }").nil? }
+        end
+
+        
+        #-------------------------------------------------------------
+        # Private Instance Methods
+        #-------------------------------------------------------------
+        private
+
+        def option_keys
+          [:name, :value, :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/iframe_model.rb

@@ -0,0 +1,148 @@
+require 'caracal/core/models/base_model'
+
+module Caracal
+  module Core
+    module Models
+
+      # This class handles block options passed to the img method.
+      #
+      class IFrameModel < BaseModel
+
+        #--------------------------------------------------
+        # Configuration
+        #--------------------------------------------------
+
+        # accessors
+        attr_reader :iframe_url
+        attr_reader :iframe_data
+        attr_reader :iframe_ignorables
+        attr_reader :iframe_namespaces
+        attr_reader :iframe_relationships
+
+        # initialization
+        def initialize(options={}, &block)
+          super options, &block
+        end
+
+
+        #--------------------------------------------------
+        # Public Methods
+        #--------------------------------------------------
+
+        #=============== PROCESSING =======================
+
+        def preprocess!
+          ::Zip::File.open(file) do |zip|
+            # locate relationships xml
+            entry      = zip.glob('word/_rels/document.xml.rels').first
+            content    = entry.get_input_stream.read
+            rel_xml    = Nokogiri::XML(content)
+
+            # locate document xml
+            entry      = zip.glob('word/document.xml').first
+            content    = entry.get_input_stream.read
+            doc_xml    = Nokogiri::XML(content)
+
+            # master nodesets
+            rel_nodes = rel_xml.children.first.children
+            doc_root  = doc_xml.at_xpath('//w:document')
+            pic_nodes = doc_xml.xpath('//pic:pic', { pic: 'http://schemas.openxmlformats.org/drawingml/2006/picture' })
+
+            # namespaces
+            @iframe_namespaces = doc_root.namespaces
+
+            # ignorable namespaces
+            if a = doc_root.attributes['Ignorable']
+              @iframe_ignorables = a.value.split(/\s+/)
+            end
+
+            # relationships
+            media_map = rel_nodes.reduce({}) do |hash, node|
+              type = node.at_xpath('@Type').value
+              if type.slice(-5, 5) == 'image'
+                id   = node.at_xpath('@Id').value
+                path = "word/#{ node.at_xpath('@Target').value }"
+                hash[id] = path
+              end
+              hash
+            end
+            @iframe_relationships = pic_nodes.reduce([]) do |array, node|
+              r_node  = node.children[1].children[0]
+              r_id    = r_node.attributes['embed'].value.to_s
+              r_media = media_map[r_id]
+
+              p_node  = node.children[0].children[0]
+              p_id    = p_node.attributes['id'].to_s.to_i
+              p_name  = p_node.attributes['name'].to_s
+              p_data  = zip.glob(r_media).first.get_input_stream.read
+
+              # register relationship
+              array << { id: r_id, type: 'image', target: p_name, data: p_data }
+              array
+            end
+          end
+        end
+
+
+        #=============== GETTERS ==========================
+
+        def file
+          @file ||= begin
+            if iframe_url.nil?
+              file = Tempfile.new('iframe')
+              file.write iframe_data
+              file.rewind
+            else
+              file = open(iframe_url)
+            end
+            file
+          end
+        end
+
+        def ignorables
+          @iframe_ignorables || []
+        end
+
+        def namespaces
+          @iframe_namespaces || {}
+        end
+
+        def relationships
+          @iframe_relationships || []
+        end
+
+
+        #=============== SETTERS ==========================
+
+        # strings
+        [:data, :url].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@iframe_#{ m }", value.to_s)
+          end
+        end
+
+
+        #=============== VALIDATION =======================
+
+        def valid?
+          vals = option_keys.map { |m| send("iframe_#{ m }") }.compact
+          vals = vals.reject { |v| v.size == 0 }
+          vals.size > 0
+        end
+
+
+
+        #--------------------------------------------------
+        # Private Methods
+        #--------------------------------------------------
+        private
+
+        def option_keys
+          [:url, :data]
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,133 @@
+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_PPI,     72)       # pixels per inch
+        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_data
+        attr_reader :image_ppi
+        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_ppi    = DEFAULT_IMAGE_PPI
+          @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].each do |m|
+          define_method "formatted_#{ m }" do
+            value = send("image_#{ m }")
+            pixels_to_emus(value, image_ppi)
+          end
+        end
+        
+        [:top, :bottom, :left, :right].each do |m|
+          define_method "formatted_#{ m }" do
+            value = send("image_#{ m }")
+            pixels_to_emus(value, 72)
+          end
+        end
+        
+        def relationship_target
+          image_url || image_data
+        end
+        
+        
+        #=============== SETTERS ==============================
+        
+        # integers
+        [:ppi, :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
+        [:data, :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 = [:ppi, :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, ppi)
+          pixels        = value.to_i
+          inches        = pixels / ppi.to_f
+          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,94 @@
+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
+        #--------------------------------------------------
+
+        # constants
+        const_set(:DEFAULT_LINK_COLOR,      '1155cc')
+        const_set(:DEFAULT_LINK_UNDERLINE,  true)
+
+        # readers (create aliases for superclass methods to conform
+        # to expected naming convention.)
+        attr_reader  :link_href
+        attr_reader  :link_internal
+        alias_method :link_content,         :text_content
+        alias_method :link_font,            :text_font
+        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
+        alias_method :link_bgcolor,         :text_bgcolor
+        alias_method :link_highlight_color, :text_highlight_color
+        alias_method :link_vertical_align,  :text_vertical_align
+
+        # initialization
+        def initialize(options={}, &block)
+          @text_color     = DEFAULT_LINK_COLOR
+          @text_underline = DEFAULT_LINK_UNDERLINE
+
+          super options, &block
+        end
+
+
+        #--------------------------------------------------
+        # Public Instance Methods
+        #--------------------------------------------------
+
+        #========== SETTERS ===============================
+
+        # booleans
+        [:internal].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@link_#{ m }", !!value)
+          end
+        end
+
+        # strings
+        [:href].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@link_#{ m }", value.to_s)
+          end
+        end
+
+
+        #========== STATE HELPERS =========================
+
+        def external?
+          !link_internal
+        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 + [:internal, :href]).flatten
+        end
+
+      end
+
+    end
+  end
+end