caracal 0.1.0

data/lib/caracal/core/relationships.rb

@@ -0,0 +1,90 @@
+require 'caracal/core/models/relationship_model'
+require 'caracal/errors'
+
+
+module Caracal
+  module Core
+    
+    # This module encapsulates all the functionality related to registering and 
+    # retrieving relationships.
+    #
+    module Relationships
+      def self.included(base)
+        base.class_eval do
+          
+          #-------------------------------------------------------------
+          # Configuration
+          #-------------------------------------------------------------
+          
+          attr_reader :relationship_counter
+          
+          
+          #-------------------------------------------------------------
+          # Class Methods
+          #-------------------------------------------------------------
+          
+          def self.default_relationships
+            [
+              { target: 'fontTable.xml',  type: :font      },
+              { target: 'footer1.xml',    type: :footer    },
+              { target: 'numbering.xml',  type: :numbering },
+              { target: 'settings.xml',   type: :setting   },
+              { target: 'styles.xml',     type: :style     }
+            ]           
+          end
+          
+          
+          #-------------------------------------------------------------
+          # Public Methods
+          #-------------------------------------------------------------
+          
+          #============== ATTRIBUTES ==========================
+          
+          def relationship(**options, &block)
+            id = relationship_counter.to_i + 1
+            options.merge!({ id: id })
+
+            model = Caracal::Core::Models::RelationshipModel.new(options, &block)
+            if model.valid?
+              @relationship_counter = id
+              rel = register_relationship(model)
+            else
+              raise Caracal::Errors::InvalidModelError, 'relationship must specify the :id, :target, and :type attributes.'
+            end
+            rel
+          end
+          
+          
+          #============== GETTERS =============================
+          
+          def relationships
+            @relationships ||= []
+          end
+                    
+          def find_relationship(target)
+            relationships.find { |r| r.matches?(target) }
+          end
+          
+          
+          #============== REGISTRATION ========================
+          
+          def register_relationship(model)
+            unless r = find_relationship(model.relationship_target)
+              relationships << model
+              r = model
+            end
+            r
+          end
+          
+          def unregister_relationship(target)
+            if r = find_relationship(target)
+              relationships.delete(r)
+            end
+          end
+          
+        end
+      end
+    end
+    
+  end
+end

data/lib/caracal/core/rules.rb

@@ -0,0 +1,35 @@
+require 'caracal/core/models/rule_model'
+require 'caracal/errors'
+
+
+module Caracal
+  module Core
+    
+    # This module encapsulates all the functionality related to adding
+    # horizontal rules to the document.
+    #
+    module Rules
+      def self.included(base)
+        base.class_eval do
+          
+          #-------------------------------------------------------------
+          # Public Methods
+          #-------------------------------------------------------------
+          
+          def hr(**options, &block)
+            model = Caracal::Core::Models::RuleModel.new(options, &block)
+            
+            if model.valid?
+              contents << model
+            else
+              raise Caracal::Errors::InvalidModelError, 'Horizontal rules require non-zero :size and :spacing values.'
+            end
+            model
+          end
+          
+        end
+      end
+    end
+    
+  end
+end

data/lib/caracal/core/styles.rb

@@ -0,0 +1,86 @@
+require 'caracal/core/models/style_model'
+require 'caracal/errors'
+
+
+module Caracal
+  module Core
+    
+    # This module encapsulates all the functionality related to defining
+    # paragraph styles.
+    #
+    module Styles
+      def self.included(base)
+        base.class_eval do
+          
+          #-------------------------------------------------------------
+          # Class Methods
+          #-------------------------------------------------------------
+          
+          def self.default_styles
+            [
+              { id: 'Normal',   name: 'normal',    font: 'Arial',    size: 20, line: 320, color: '333333' },
+              { id: 'Heading1', name: 'heading 1', font: 'Palatino', size: 36, bottom: 120 },
+              { id: 'Heading2', name: 'heading 2', font: 'Arial',    size: 26, top: 120, bottom: 160, bold: true },
+              { id: 'Heading3', name: 'heading 3', font: 'Arial',    size: 24, top: 120, bottom: 160, bold: true, italic: true, color: '666666' },
+              { id: 'Heading4', name: 'heading 4', font: 'Palatino', size: 24, top: 120, bottom: 120, bold: true },
+              { id: 'Heading5', name: 'heading 5', font: 'Arial',    size: 22, top: 120, bottom: 120, bold: true },
+              { id: 'Heading6', name: 'heading 6', font: 'Arial',    size: 22, top: 120, bottom: 120, underline: true, italic: true, color: '666666' },
+              { id: 'Title',    name: 'title',     font: 'Palatino', size: 60 },
+              { id: 'Subtitle', name: 'subtitle',  font: 'Arial',    size: 28, top: 60 }
+            ]           
+          end
+          
+          
+          #-------------------------------------------------------------
+          # Public Methods
+          #-------------------------------------------------------------
+          
+          #============== ATTRIBUTES ==========================
+          
+          def style(**options, &block)
+            model = Caracal::Core::Models::StyleModel.new(options, &block)
+            
+            if model.valid?
+              register_style(model)
+            else
+              raise Caracal::Errors::InvalidModelError, 'style must define an :id and :name.'
+            end
+            model
+          end
+          
+          
+          #============== GETTERS =============================
+          
+          def styles
+            @styles ||= []
+          end
+          
+          def default_style
+            styles.find { |s| s.style_default }
+          end
+          
+          def find_style(id)
+            styles.find { |s| s.matches?(id) }
+          end
+          
+          
+          #============== REGISTRATION ========================
+          
+          def register_style(model)
+            unregister_style(model.style_id)
+            styles << model
+            model
+          end
+          
+          def unregister_style(id)
+            if s = find_style(id)
+              styles.delete(s)
+            end
+          end
+          
+        end
+      end
+    end
+    
+  end
+end

data/lib/caracal/core/tables.rb

@@ -0,0 +1,41 @@
+require 'caracal/core/models/table_model'
+require 'caracal/errors'
+
+
+module Caracal
+  module Core
+    
+    # This module encapsulates all the functionality related to adding tables
+    # to the document.
+    #
+    module Tables
+      def self.included(base)
+        base.class_eval do
+          
+          #-------------------------------------------------------------
+          # Public Methods
+          #-------------------------------------------------------------
+          
+          def table(data, **options, &block)
+            options.merge!({ data: data })
+            
+            model = Caracal::Core::Models::TableModel.new(options, &block)
+            if respond_to?(:page_width)
+              container_width = page_width - page_margin_left - page_margin_right
+              model.calculate_width(container_width)
+            end
+            
+            if model.valid?
+              contents << model
+            else
+              raise Caracal::Errors::InvalidModelError, 'Table must be provided data for at least one cell.'
+            end
+            model
+          end
+          
+        end
+      end
+    end
+    
+  end
+end

data/lib/caracal/core/text.rb

@@ -0,0 +1,73 @@
+require 'caracal/core/models/paragraph_model'
+require 'caracal/errors'
+
+
+module Caracal
+  module Core
+    
+    # This module encapsulates all the functionality related to adding text
+    # to the document.
+    #
+    module Text
+      def self.included(base)
+        base.class_eval do
+          
+          #-------------------------------------------------------------
+          # Public Methods
+          #-------------------------------------------------------------
+          
+          #============== PARAGRAPHS ==========================
+          
+          def p(*text, **options, &block)
+            text.flatten!            
+            options.merge!( { content: text[0] })  unless text[0].nil?
+            
+            model = Caracal::Core::Models::ParagraphModel.new(options, &block)
+            if model.valid?
+              contents << model
+            else
+              raise Caracal::Errors::InvalidModelError, 'Paragraphs and headings, which delegate to the :p command, require at least one text string.'
+            end
+            model
+          end
+          
+          
+          #============== HEADINGS ============================
+          
+          # All heading methods simply delegate to the paragraph
+          # model with an explicitly set style class.
+          #
+          [:h1, :h2, :h3, :h4, :h5, :h6].each do |cmd|
+            define_method "#{ cmd }" do |*text, **options, &block|
+              options.merge!({ style: style_id_for_header(cmd) })
+              p(text, options, &block)
+            end
+          end
+          
+          
+          #-------------------------------------------------------------
+          # Private Methods
+          #-------------------------------------------------------------
+          private
+          
+          # This method translates the html-like command to the 
+          # corresponding style id.
+          #
+          def style_id_for_header(command)
+            case command.to_s
+              when 'h1' then 'Heading1'
+              when 'h2' then 'Heading2'
+              when 'h3' then 'Heading3'
+              when 'h4' then 'Heading4'
+              when 'h5' then 'Heading5'
+              when 'h6' then 'Heading6'
+              else 'Normal'
+            end
+          end
+          
+        end
+      end
+    end
+    
+  end
+end

data/lib/caracal/document.rb

@@ -0,0 +1,242 @@
+require 'open-uri'
+require 'zip'
+
+require 'caracal/core/file_name'
+require 'caracal/core/fonts'
+require 'caracal/core/images'
+require 'caracal/core/line_breaks'
+require 'caracal/core/list_styles'
+require 'caracal/core/lists'
+require 'caracal/core/page_breaks'
+require 'caracal/core/page_numbers'
+require 'caracal/core/page_settings'
+require 'caracal/core/relationships'
+require 'caracal/core/rules'
+require 'caracal/core/styles'
+require 'caracal/core/tables'
+require 'caracal/core/text'
+
+require 'caracal/renderers/app_renderer'
+require 'caracal/renderers/content_types_renderer'
+require 'caracal/renderers/core_renderer'
+require 'caracal/renderers/document_renderer'
+require 'caracal/renderers/fonts_renderer'
+require 'caracal/renderers/footer_renderer'
+require 'caracal/renderers/numbering_renderer'
+require 'caracal/renderers/package_relationships_renderer'
+require 'caracal/renderers/relationships_renderer'
+require 'caracal/renderers/settings_renderer'
+require 'caracal/renderers/styles_renderer'
+
+
+module Caracal
+  class Document
+    
+    #-------------------------------------------------------------
+    # Configuration
+    #-------------------------------------------------------------
+    
+    # mixins (order is important)
+    include Caracal::Core::FileName
+    
+    include Caracal::Core::Relationships
+    include Caracal::Core::Fonts
+    include Caracal::Core::PageSettings
+    include Caracal::Core::PageNumbers
+    include Caracal::Core::Styles
+    include Caracal::Core::ListStyles
+    
+    include Caracal::Core::Images
+    include Caracal::Core::LineBreaks
+    include Caracal::Core::Lists
+    include Caracal::Core::PageBreaks
+    include Caracal::Core::Rules
+    include Caracal::Core::Tables
+    include Caracal::Core::Text
+    
+    
+    #-------------------------------------------------------------
+    # Public Class Methods
+    #-------------------------------------------------------------
+    
+    #============ GETTERS ===================================
+    
+    # This method returns an array of models which constitute the 
+    # set of instructions for producing the document content.
+    #
+    def contents
+      @contents ||= []
+    end
+    
+    
+    #============ OUTPUT ====================================
+    
+    # This method renders a new Word document and returns it as a
+    # a string.
+    #
+    def self.render(f_name = nil, &block)
+      docx   = new(f_name, &block)
+      buffer = docx.render
+      
+      buffer.rewind
+      buffer.sysread
+    end
+    
+    # This method renders a new Word document and saves it to the
+    # file system.
+    #
+    def self.save(f_name = nil, &block)
+      docx   = new(f_name, &block)
+      buffer = docx.render
+      
+      File.open("./#{ docx.name }", 'w') { |f| f.write(buffer.string) }
+    end
+    
+    
+    
+    #-------------------------------------------------------------
+    # Public Instance Methods
+    #-------------------------------------------------------------
+    
+    # This method instantiates a new word document.
+    #
+    def initialize(name = nil, &block)
+      file_name(name)
+      
+      page_size 
+      page_margins top: 1440, bottom: 1440, left: 1440, right: 1440
+      page_numbers
+      
+      [:relationship, :font, :style, :list_style].each do |method|
+        collection = self.class.send("default_#{ method }s")
+        collection.each do |item|
+          send(method, item)
+        end
+      end
+            
+      if block_given?
+        (block.arity < 1) ? instance_eval(&block) : block[self]
+      end
+    end
+    
+    
+    #============ RENDERING =================================
+    
+    # This method renders the word document instance into 
+    # a string buffer. Order is important!
+    #
+    def render
+      buffer = ::Zip::OutputStream.write_buffer do |zip|
+        render_package_relationships(zip)
+        render_content_types(zip)
+        render_app(zip)
+        render_core(zip)
+        render_fonts(zip)
+        render_footer(zip)
+        render_settings(zip)
+        render_styles(zip)
+        render_document(zip)
+        render_relationships(zip)   # Must go here: Depends on document renderer
+        render_media(zip)           # Must go here: Depends on document renderer
+        render_numbering(zip)       # Must go here: Depends on document renderer
+      end
+    end
+    
+    
+    
+    #-------------------------------------------------------------
+    # Private Instance Methods
+    #-------------------------------------------------------------
+    private
+    
+    #============ RENDERERS =====================================
+    
+    def render_app(zip)
+      content = ::Caracal::Renderers::AppRenderer.render(self)
+      
+      zip.put_next_entry('docProps/app.xml')
+      zip.write(content)
+    end
+    
+    def render_content_types(zip)
+      content = ::Caracal::Renderers::ContentTypesRenderer.render(self)
+      
+      zip.put_next_entry('[Content_Types].xml')
+      zip.write(content)
+    end
+    
+    def render_core(zip)
+      content = ::Caracal::Renderers::CoreRenderer.render(self)
+      
+      zip.put_next_entry('docProps/core.xml')
+      zip.write(content)
+    end
+    
+    def render_document(zip)
+      content = ::Caracal::Renderers::DocumentRenderer.render(self)
+      
+      zip.put_next_entry('word/document.xml')
+      zip.write(content)
+    end
+    
+    def render_fonts(zip)
+      content = ::Caracal::Renderers::FontsRenderer.render(self)
+      
+      zip.put_next_entry('word/fontTable.xml')
+      zip.write(content)
+    end
+    
+    def render_footer(zip)
+      content = ::Caracal::Renderers::FooterRenderer.render(self)
+      
+      zip.put_next_entry('word/footer1.xml')
+      zip.write(content)
+    end
+    
+    def render_media(zip)
+      images = relationships.select { |r| r.relationship_type == :image }
+      images.each do |rel|
+        content = open(rel.relationship_target).read
+        
+        zip.put_next_entry("word/#{ rel.formatted_target }")
+        zip.write(content)
+      end
+    end
+    
+    def render_numbering(zip)
+      content = ::Caracal::Renderers::NumberingRenderer.render(self)
+      
+      zip.put_next_entry('word/numbering.xml')
+      zip.write(content)
+    end
+    
+    def render_package_relationships(zip)
+      content = ::Caracal::Renderers::PackageRelationshipsRenderer.render(self)
+      
+      zip.put_next_entry('_rels/.rels')
+      zip.write(content)
+    end
+    
+    def render_relationships(zip)
+      content = ::Caracal::Renderers::RelationshipsRenderer.render(self)
+      
+      zip.put_next_entry('word/_rels/document.xml.rels')
+      zip.write(content)
+    end
+    
+    def render_settings(zip)
+      content = ::Caracal::Renderers::SettingsRenderer.render(self)
+      
+      zip.put_next_entry('word/settings.xml')
+      zip.write(content)
+    end
+    
+    def render_styles(zip)
+      content = ::Caracal::Renderers::StylesRenderer.render(self)
+      
+      zip.put_next_entry('word/styles.xml')
+      zip.write(content)
+    end
+        
+  end
+end