caracal_the_curve 1.4.1

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

@@ -0,0 +1,79 @@
+require 'caracal/core/models/base_model'
+
+
+module Caracal
+  module Core
+    module Models
+
+      # This class handles block options passed to the page size
+      # method.
+      #
+      class PageSizeModel < BaseModel
+
+        #-------------------------------------------------------------
+        # Configuration
+        #-------------------------------------------------------------
+
+        # constants
+        const_set(:DEFAULT_PAGE_WIDTH,        12240)  # 8.5in  in twips
+        const_set(:DEFAULT_PAGE_HEIGHT,       15840)  # 11.0in in twips
+        const_set(:DEFAULT_PAGE_ORIENTATION,  'portrait')
+
+        # accessors
+        attr_reader :page_width
+        attr_reader :page_height
+        attr_reader :page_orientation
+
+        # initialization
+        def initialize(options={}, &block)
+          @page_width       = DEFAULT_PAGE_WIDTH
+          @page_height      = DEFAULT_PAGE_HEIGHT
+          @page_orientation = DEFAULT_PAGE_ORIENTATION
+
+          super options, &block
+        end
+
+
+        #-------------------------------------------------------------
+        # Public Methods
+        #-------------------------------------------------------------
+
+        #=============== SETTERS ==============================
+
+        def height(value)
+          @page_height = value.to_i
+        end
+
+        def orientation(value)
+          allowed = ['landscape','portrait']
+          given   = value.to_s.downcase
+          @page_orientation = allowed.include?(given) ? given : 'portrait'
+        end
+
+        def width(value)
+          @page_width = value.to_i
+        end
+
+
+        #=============== VALIDATION ==============================
+
+        def valid?
+          dims = [page_width, page_height]
+          dims.all? { |d| d > 0 }
+        end
+
+
+        #-------------------------------------------------------------
+        # Private Instance Methods
+        #-------------------------------------------------------------
+        private
+
+        def option_keys
+          [:width, :height, :orientation]
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,186 @@
+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/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
+        attr_reader :paragraph_bgcolor
+
+        # initialization
+        def initialize(options={}, &block)
+          content = options.delete(:content) { "" }
+          text content, options.dup, &block
+          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,
+            bgcolor:    paragraph_bgcolor
+          }
+        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
+        [:bgcolor, :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 ===========================
+
+        # .bookmarks
+        def bookmark_start(*args, &block)
+          options = Caracal::Utilities.extract_options!(args)
+          options.merge!({ start: true})
+
+          model = Caracal::Core::Models::BookmarkModel.new(options, &block)
+          if model.valid?
+            runs << model
+          else
+            raise Caracal::Errors::InvalidModelError, 'Bookmark starting tags require an id and a name.'
+          end
+          model
+        end
+        def bookmark_end(*args, &block)
+          options = Caracal::Utilities.extract_options!(args)
+          options.merge!({ start: false})
+
+          model = Caracal::Core::Models::BookmarkModel.new(options, &block)
+          if model.valid?
+            runs << model
+          else
+            raise Caracal::Errors::InvalidModelError, 'Bookmark ending tags require an id.'
+          end
+          model
+        end
+
+        # .br
+        def br
+          model = Caracal::Core::Models::LineBreakModel.new()
+          runs << model
+          model
+        end
+
+        # .link
+        def link(*args, &block)
+          options = Caracal::Utilities.extract_options!(args)
+          options.merge!({ content: args[0] }) if args[0]
+          options.merge!({ href:    args[1] }) if args[1]
+
+          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
+          model
+        end
+
+        # .page
+        def page
+          model = Caracal::Core::Models::PageBreakModel.new({ wrap: false })
+          runs << model
+          model
+        end
+
+        # .text
+        def text(*args, &block)
+          options = Caracal::Utilities.extract_options!(args)
+          options.merge!({ content: args.first }) if args.first
+
+          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
+          model
+        end
+
+
+        #========== VALIDATION ============================
+
+        def valid?
+          runs.size > 0
+        end
+
+
+        #--------------------------------------------------
+        # Private Instance Methods
+        #--------------------------------------------------
+        private
+
+        def option_keys
+          [:content, :style, :align, :color, :size, :bold, :italic, :underline, :bgcolor]
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,114 @@
+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_key
+        attr_reader :relationship_type
+        attr_reader :relationship_target
+        attr_reader :relationship_data
+    
+        
+        
+        #-------------------------------------------------------------
+        # 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
+            ext = ext.split('?').first
+            "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 type(value)
+          @relationship_type = value.to_s.downcase.to_sym
+        end
+        
+        def target(value)
+          @relationship_target = value.to_s
+          @relationship_key    = value.to_s.downcase
+        end
+        
+        def data(value)
+          @relationship_data = value.to_s
+        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, :data]
+        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,165 @@
+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_TYPE,       'paragraph')
+        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_CAPS,       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_type
+        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_caps
+        attr_reader :style_align
+        attr_reader :style_top
+        attr_reader :style_bottom
+        attr_reader :style_line
+        attr_reader :style_base
+        attr_reader :style_next
+        attr_reader :style_indent_left
+        attr_reader :style_indent_right
+        attr_reader :style_indent_first
+
+        # initialization
+        def initialize(options={}, &block)
+          @style_default = false
+          @style_type    = DEFAULT_STYLE_TYPE
+          @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_caps       ||= DEFAULT_STYLE_CAPS
+            @style_align      ||= DEFAULT_STYLE_ALIGN
+            @style_top        ||= DEFAULT_STYLE_TOP
+            @style_bottom     ||= DEFAULT_STYLE_BOTTOM
+            @style_line       ||= DEFAULT_STYLE_LINE
+          end
+        end
+
+
+        #--------------------------------------------------
+        # Public Methods
+        #--------------------------------------------------
+
+        #========== SETTERS ===============================
+
+        # booleans
+        [:bold, :italic, :underline, :caps].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@style_#{ m }", !!value)
+          end
+        end
+
+        # integers
+        [:bottom, :size, :line, :top, :indent_left, :indent_right, :indent_first].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@style_#{ m }", value.to_i)
+          end
+        end
+
+        # strings
+        [:id, :type, :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
+
+        # custom
+        def type(value)
+          allowed     = ['character', 'paragraph']
+          given       = value.to_s.downcase.strip
+          @style_type = allowed.include?(given) ? given : DEFAULT_STYLE_TYPE
+        end
+
+
+        #========== STATE =================================
+
+        def matches?(str)
+          style_id.downcase == str.to_s.downcase
+        end
+
+
+        #========== VALIDATION ============================
+
+        def valid?
+          a = [:id, :name, :type]
+          a.map { |m| send("style_#{ m }") }.compact.size == a.size
+        end
+
+
+        #--------------------------------------------------
+        # Private Methods
+        #--------------------------------------------------
+        private
+
+        def option_keys
+          [ :type,
+            :bold,
+            :italic,
+            :underline,
+            :caps,
+            :top,
+            :bottom,
+            :size,
+            :line,
+            :id,
+            :name,
+            :color,
+            :font,
+            :align,
+            :indent_left,
+            :indent_right,
+            :indent_first ]
+        end
+
+      end
+
+    end
+  end
+end