caracal_the_curve 1.4.1

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

@@ -0,0 +1,108 @@
+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
+        alias_method :list_item_bgcolor,   :paragraph_bgcolor
+
+
+
+        #-------------------------------------------------------------
+        # 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
+          model
+        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
+          model
+        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, :bgcolor]
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,132 @@
+require 'caracal/core/models/base_model'
+require 'caracal/core/models/list_item_model'
+require 'caracal/errors'
+
+
+module Caracal
+  module Core
+    module Models
+      
+      # This class encapsulates the logic needed to store and manipulate
+      # list data.
+      #
+      class ListModel < BaseModel
+        
+        #-------------------------------------------------------------
+        # Configuration
+        #-------------------------------------------------------------
+        
+        # constants
+        const_set(:DEFAULT_LIST_TYPE,  :unordered)
+        const_set(:DEFAULT_LIST_LEVEL, 0)
+        
+        # accessors
+        attr_reader :list_type
+        attr_reader :list_level
+        
+        
+        # initialization
+        def initialize(options={}, &block)
+          @list_type  = DEFAULT_LIST_TYPE
+          @list_level = DEFAULT_LIST_LEVEL
+          
+          super options, &block
+        end
+        
+        
+        #-------------------------------------------------------------
+        # Public Instance Methods
+        #-------------------------------------------------------------
+    
+        #=============== GETTERS ==============================
+        
+        # This method returns only those items owned directly 
+        # by this list.
+        #
+        def items
+          @items ||= []
+        end
+        
+        # This method returns a hash, where the keys are levels
+        # and the values are the list type at that level.
+        #
+        def level_map
+          recursive_items.reduce({}) do |hash, item|
+            hash[item.list_item_level] = item.list_item_type
+            hash
+          end
+        end
+      
+        # This method returns a flattened array containing every 
+        # item within this list's tree.
+        #
+        def recursive_items
+          items.map do |model|
+            if model.nested_list.nil?
+              model
+            else
+              [model, model.nested_list.recursive_items]
+            end
+          end.flatten
+        end
+        
+        
+        #=============== SETTERS ==============================
+        
+        # integers
+        [:level].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@list_#{ m }", value.to_i)
+          end
+        end
+
+        # symbols
+        [:type].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@list_#{ m }", value.to_s.to_sym)
+          end
+        end
+        
+        
+        #=============== SUB-METHODS ===========================
+        
+        # .li
+        def li(*args, &block)
+          options = Caracal::Utilities.extract_options!(args)
+          options.merge!({ content: args.first }) if args.first
+          options.merge!({ type:    list_type  })
+          options.merge!({ level:   list_level })
+          
+          model = Caracal::Core::Models::ListItemModel.new(options, &block)
+          if model.valid?
+            items << model
+          else
+            raise Caracal::Errors::InvalidModelError, 'List item must have at least one run.'
+          end
+          model
+        end
+        
+        
+        #=============== VALIDATION ===========================
+        
+        def valid?
+          a = [:type, :level]
+          required = a.map { |m| send("list_#{ m }") }.compact.size == a.size
+          required && !items.empty?
+        end
+        
+        
+        #-------------------------------------------------------------
+        # Private Instance Methods
+        #-------------------------------------------------------------
+        private
+        
+        def option_keys
+          [:type, :level]
+        end
+        
+      end
+      
+    end
+  end
+end

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

@@ -0,0 +1,118 @@
+module Caracal
+  module Core
+    module Models
+      
+      # This class encapsulates the logic needed to store and manipulate
+      # list style data.
+      #
+      class ListStyleModel < BaseModel
+        
+        #-------------------------------------------------------------
+        # Configuration
+        #-------------------------------------------------------------
+        
+        # constants
+        const_set(:TYPE_MAP,              { ordered: 1, unordered: 2 })
+        const_set(:DEFAULT_STYLE_LEFT,    720)      # units in twips 
+        const_set(:DEFAULT_STYLE_INDENT,  360)      # units in twips 
+        const_set(:DEFAULT_STYLE_ALIGN,   :left)
+        const_set(:DEFAULT_STYLE_START,   1)
+        const_set(:DEFAULT_STYLE_RESTART, 1)
+        
+        # accessors
+        attr_reader :style_type
+        attr_reader :style_level
+        attr_reader :style_format
+        attr_reader :style_value
+        attr_reader :style_start
+        attr_reader :style_align
+        attr_reader :style_left
+        attr_reader :style_indent
+        attr_reader :style_restart
+        
+        
+        # initialization
+        def initialize(options={}, &block)
+          @style_align   = DEFAULT_STYLE_ALIGN
+          @style_left    = DEFAULT_STYLE_LEFT
+          @style_indent  = DEFAULT_STYLE_INDENT
+          @style_start   = DEFAULT_STYLE_START
+          @style_restart = DEFAULT_STYLE_RESTART
+          
+          super options, &block
+        end
+        
+        
+        #-------------------------------------------------------------
+        # Public Class Methods
+        #-------------------------------------------------------------
+        
+        def self.formatted_type(type)
+          TYPE_MAP.fetch(type.to_s.to_sym)
+        end
+        
+        
+        #-------------------------------------------------------------
+        # Public Instance Methods
+        #-------------------------------------------------------------
+    
+        #=============== GETTERS ==============================
+        
+        def formatted_type
+          self.class.formatted_type(style_type)
+        end
+        
+        
+        #=============== SETTERS ==============================
+        
+        # integers
+        [:level, :left, :indent, :start, :restart].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@style_#{ m }", value.to_i)
+          end
+        end
+        
+        # strings
+        [:format, :value].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@style_#{ m }", value.to_s)
+          end
+        end
+        
+        # symbols
+        [:type, :align].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@style_#{ m }", value.to_s.to_sym)
+          end
+        end
+        
+        
+        #=============== STATE ================================
+        
+        def matches?(type, level)
+          style_type == type.to_s.to_sym && style_level == level.to_i
+        end
+        
+        
+        #=============== VALIDATION ===========================
+        
+        def valid?
+          a = [:type, :level, :format, :value]
+          a.map { |m| send("style_#{ m }") }.compact.size == a.size
+        end
+        
+        
+        #-------------------------------------------------------------
+        # Private Instance Methods
+        #-------------------------------------------------------------
+        private
+        
+        def option_keys
+          [:type, :level, :format, :value, :align, :left, :indent, :start]
+        end
+        
+      end
+      
+    end
+  end
+end

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

@@ -0,0 +1,76 @@
+require 'caracal/core/models/base_model'
+
+
+module Caracal
+  module Core
+    module Models
+      
+      # This class handles block options passed to the margins
+      # method.
+      #
+      class MarginModel < BaseModel
+        
+        #-------------------------------------------------------------
+        # Configuration
+        #-------------------------------------------------------------
+        
+        # constants
+        const_set(:DEFAULT_MARGIN_TOP,    0)  # units in twips
+        const_set(:DEFAULT_MARGIN_BOTTOM, 0)  # units in twips
+        const_set(:DEFAULT_MARGIN_LEFT,   0)  # units in twips
+        const_set(:DEFAULT_MARGIN_RIGHT,  0)  # units in twips
+        
+        # accessors
+        attr_reader :margin_top
+        attr_reader :margin_bottom
+        attr_reader :margin_left
+        attr_reader :margin_right
+        
+        
+        # initialization
+        def initialize(options={}, &block)
+          @margin_top    = DEFAULT_MARGIN_TOP
+          @margin_bottom = DEFAULT_MARGIN_BOTTOM
+          @margin_left   = DEFAULT_MARGIN_LEFT
+          @margin_right  = DEFAULT_MARGIN_RIGHT
+          
+          super options, &block
+        end
+        
+        
+        #-------------------------------------------------------------
+        # Public Methods
+        #-------------------------------------------------------------
+        
+        #=============== SETTERS ==============================
+        
+        # integers
+        [:bottom, :left, :right, :top].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@margin_#{ m }", value.to_i)
+          end
+        end
+        
+        
+        #=============== VALIDATION ==============================
+        
+        def valid?
+          dims = [:bottom, :left, :right, :top]
+          dims.map { |d| send("margin_#{ d }") }.all? { |d| d > 0 }
+        end
+        
+        
+        #-------------------------------------------------------------
+        # Private Instance Methods
+        #-------------------------------------------------------------
+        private
+        
+        def option_keys
+          [:top, :bottom, :left, :right]
+        end
+        
+      end
+      
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+require 'caracal/core/models/base_model'
+
+
+module Caracal
+  module Core
+    module Models
+
+      # This class encapsulates the logic needed to store and manipulate
+      # namespace data.
+      #
+      class NamespaceModel < BaseModel
+
+        #-------------------------------------------------------------
+        # Configuration
+        #-------------------------------------------------------------
+
+        # accessors
+        attr_reader :namespace_prefix
+        attr_reader :namespace_href
+
+
+
+        #-------------------------------------------------------------
+        # Public Instance Methods
+        #-------------------------------------------------------------
+
+        #=================== SETTERS =============================
+
+        # strings
+        [:href, :prefix].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@namespace_#{ m }", value.to_s)
+          end
+        end
+
+
+        #=================== STATE ===============================
+
+        def matches?(str)
+          namespace_prefix == str.to_s
+        end
+
+
+        #=============== VALIDATION ===========================
+
+        def valid?
+          required = [:href, :prefix]
+          required.all? { |m| !send("namespace_#{ m }").nil? }
+        end
+
+
+        #-------------------------------------------------------------
+        # Private Instance Methods
+        #-------------------------------------------------------------
+        private
+
+        def option_keys
+          [:prefix, :href]
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+require 'caracal/core/models/base_model'
+
+
+module Caracal
+  module Core
+    module Models
+
+      # This class encapsulates the logic needed to store and manipulate
+      # page break data.
+      #
+      # The :wrap option is not described in the project's README because
+      # it exists purely as an internal Caracal concern. Page breaks
+      # at the document level must be wrapped in a paragraph node; page breaks
+      # within paragraph-like container simply add a run.  There's no need to
+      # trouble end users with this issue.
+      #
+      class PageBreakModel < BaseModel
+
+        #-------------------------------------------------------------
+        # Configuration
+        #-------------------------------------------------------------
+
+        # constants
+        const_set(:DEFAULT_PAGE_BREAK_WRAP, true)
+
+        # accessors
+        attr_reader :page_break_wrap
+
+        # initialization
+        def initialize(options={}, &block)
+          @page_break_wrap = DEFAULT_PAGE_BREAK_WRAP
+
+          super options, &block
+        end
+
+
+        #-------------------------------------------------------------
+        # Public Methods
+        #-------------------------------------------------------------
+
+        #=============== SETTERS ==============================
+
+        def wrap(value)
+          @page_break_wrap = !!value
+        end
+
+
+        #-------------------------------------------------------------
+        # Private Instance Methods
+        #-------------------------------------------------------------
+        private
+
+        def option_keys
+          [:wrap]
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,95 @@
+require 'caracal/core/models/base_model'
+
+
+module Caracal
+  module Core
+    module Models
+
+      # This class handles block options passed to the page_numbers
+      # method.
+      #
+      class PageNumberModel < BaseModel
+
+        #-------------------------------------------------------------
+        # Configuration
+        #-------------------------------------------------------------
+
+        # constants
+        const_set(:DEFAULT_PAGE_NUMBER_ALIGN, :center)
+        const_set(:DEFAULT_PAGE_NUMBER_SHOW,  false)
+
+        # 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
+
+        # initialization
+        def initialize(options={}, &block)
+          @page_number_align        = DEFAULT_PAGE_NUMBER_ALIGN
+          @page_number_label        = nil
+          @page_number_label_size   = nil
+          @page_number_number_size  = nil
+          @page_number_show         = DEFAULT_PAGE_NUMBER_SHOW
+
+          super options, &block
+        end
+
+
+        #-------------------------------------------------------------
+        # Public Methods
+        #-------------------------------------------------------------
+
+        #=============== SETTERS ==============================
+
+        def align(value)
+          @page_number_align = value.to_s.to_sym
+        end
+
+        def label(value)
+          @page_number_label = value.to_s.strip   # renderer will enforce trailing space
+        end
+
+        def label_size(value)
+          v = value.to_i
+          @page_number_label_size = (v == 0) ? nil : v
+        end
+
+        def number_size(value)
+          v = value.to_i
+          @page_number_number_size = (v == 0) ? nil : v
+        end
+
+        def show(value)
+          @page_number_show = !!value
+        end
+
+        def size(value)
+          v = value.to_i
+          @page_number_label_size  = (v == 0) ? nil : v
+          @page_number_number_size = (v == 0) ? nil : v
+        end
+
+
+        #=============== VALIDATION ===========================
+
+        def valid?
+          (!page_number_show || [:left, :center, :right].include?(page_number_align))
+        end
+
+
+        #-------------------------------------------------------------
+        # Private Instance Methods
+        #-------------------------------------------------------------
+        private
+
+        def option_keys
+          [:align, :label, :label_size, :number_size, :show]
+        end
+
+      end
+
+    end
+  end
+end