caracal 0.1.0

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/caracal.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'caracal/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'caracal'
+  spec.version       = Caracal::VERSION
+  spec.authors       = ['Trade Infomatics', 'John Dugan']
+  spec.email         = ['jpdugan@gmail.com']
+  spec.summary       = %q{ Fast, professional MSWord writer for Ruby. }
+  spec.description   = %q{ Caracal is a pure Ruby MSWord generation library that produces professional quality Word documents using a simple, HTML-style DSL. }
+  spec.homepage      = 'https://github.com/trade-informatics/caracal'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'nokogiri', '~> 1.6'
+  spec.add_dependency 'rubyzip',  '~> 1.1'
+  spec.add_dependency 'tilt',     '~> 1.4'
+  
+  spec.add_development_dependency 'bundler',  '~> 1.6'
+  spec.add_development_dependency 'rspec',    '~> 3.0'
+end

data/lib/caracal.rb

@@ -0,0 +1,31 @@
+#------------------------------------------------
+# Requirements
+#------------------------------------------------
+
+# external dependencies
+require 'tilt'
+
+# odds & ends
+require 'caracal/errors'
+require 'caracal/version'
+
+# document
+require 'caracal/document'
+
+
+#------------------------------------------------
+# Extra Setup
+#------------------------------------------------
+
+# Add functions to table cell model. we do this here to 
+# avoid a circular require between Caracal::Core::Tables 
+# and Caracal::Core::Models::TableCellModel.
+#
+Caracal::Core::Models::TableCellModel.class_eval do
+  include Caracal::Core::Images
+  include Caracal::Core::LineBreaks
+  include Caracal::Core::Lists
+  include Caracal::Core::Rules
+  include Caracal::Core::Tables
+  include Caracal::Core::Text
+end

data/lib/caracal/core/file_name.rb

@@ -0,0 +1,39 @@
+module Caracal
+  module Core
+    
+    # This module encapsulates all the functionality related to setting the 
+    # document's name.
+    #
+    module FileName
+      def self.included(base)
+        base.class_eval do
+          
+          #-------------------------------------------------------------
+          # Configuration
+          #-------------------------------------------------------------
+    
+          # constants
+          const_set(:DEFAULT_FILE_NAME, 'caracal.docx')
+          
+          # accessors
+          attr_reader :name
+          
+          
+          #-------------------------------------------------------------
+          # Public Methods
+          #-------------------------------------------------------------
+    
+          # This method sets the name of the output file. Defaults
+          # to the name of the library.
+          #
+          def file_name(value = nil)
+            v = value.to_s.strip
+            @name = (v == '') ? self.class::DEFAULT_FILE_NAME : v
+          end
+          
+        end
+      end
+    end
+    
+  end
+end

data/lib/caracal/core/fonts.rb

@@ -0,0 +1,75 @@
+require 'caracal/core/models/font_model'
+require 'caracal/errors'
+
+
+module Caracal
+  module Core
+    
+    # This module encapsulates all the functionality related to registering
+    # fonts.
+    #
+    module Fonts
+      def self.included(base)
+        base.class_eval do
+          
+          #-------------------------------------------------------------
+          # Class Methods
+          #-------------------------------------------------------------
+          
+          def self.default_fonts
+            [
+              { name: 'Arial' },
+              { name: 'Trebuchet MS' }
+            ]           
+          end
+          
+          
+          #-------------------------------------------------------------
+          # Public Methods
+          #-------------------------------------------------------------
+          
+          #============== ATTRIBUTES ==========================
+          
+          def font(opts, &block)
+            model = Caracal::Core::Models::FontModel.new(opts, &block)
+            
+            if model.valid?
+              register_font(model)
+            else
+              raise Caracal::Errors::InvalidModelError, 'font must specify the :name attribute.'
+            end
+            model
+          end
+          
+          
+          #============== GETTERS =============================
+          
+          def fonts
+            @fonts ||= []
+          end
+          
+          def find_font(name)
+            fonts.find { |f| f.matches?(name) }
+          end
+          
+          
+          #============== REGISTRATION ========================
+          
+          def register_font(model)
+            unregister_font(model.font_name)
+            fonts << model
+            model
+          end
+          
+          def unregister_font(name)
+            if f = find_font(name)
+              fonts.delete(f)
+            end
+          end
+          
+        end
+      end
+    end
+    
+  end
+end

data/lib/caracal/core/images.rb

@@ -0,0 +1,37 @@
+require 'caracal/core/models/image_model'
+require 'caracal/errors'
+
+
+module Caracal
+  module Core
+    
+    # This module encapsulates all the functionality related to adding
+    # images to the document.
+    #
+    module Images
+      def self.included(base)
+        base.class_eval do
+          
+          #-------------------------------------------------------------
+          # Public Methods
+          #-------------------------------------------------------------
+          
+          def img(*text, **options, &block)
+            text.flatten!            
+            options.merge!( { url: text[0] })  unless text[0].nil?
+            
+            model = Caracal::Core::Models::ImageModel.new(options, &block)
+            if model.valid?
+              contents << model
+            else
+              raise Caracal::Errors::InvalidModelError, 'Images require an URL and positive size/margin values.'
+            end
+            model
+          end
+          
+        end
+      end
+    end
+    
+  end
+end

data/lib/caracal/core/line_breaks.rb

@@ -0,0 +1,29 @@
+require 'caracal/core/models/line_break_model'
+
+
+module Caracal
+  module Core
+    
+    # This module encapsulates all the functionality related to adding line
+    # breaks to the document.
+    #
+    module LineBreaks
+      def self.included(base)
+        base.class_eval do
+          
+          #-------------------------------------------------------------
+          # Public Methods
+          #-------------------------------------------------------------
+          
+          def br
+            model     = Caracal::Core::Models::LineBreakModel.new()
+            contents << model
+            model
+          end
+          
+        end
+      end
+    end
+    
+  end
+end

data/lib/caracal/core/list_styles.rb

@@ -0,0 +1,92 @@
+require 'caracal/core/models/list_style_model'
+require 'caracal/errors'
+
+
+module Caracal
+  module Core
+    
+    # This module encapsulates all the functionality related to defining
+    # list styles.
+    #
+    module ListStyles
+      def self.included(base)
+        base.class_eval do
+          
+          #-------------------------------------------------------------
+          # Class Methods
+          #-------------------------------------------------------------
+          
+          def self.default_list_styles
+            [
+              { type: :ordered,   level: 0, format: 'decimal',     value: '%1.', left: 720,  line: 360  },
+              { type: :ordered,   level: 1, format: 'lowerLetter', value: '%2.', left: 1440, line: 1080 },
+              { type: :ordered,   level: 2, format: 'lowerRoman',  value: '%3.', left: 2160, line: 1800, align: :right },
+              { type: :ordered,   level: 3, format: 'decimal',     value: '%4.', left: 2880, line: 2520 },
+              { type: :ordered,   level: 4, format: 'lowerLetter', value: '%5.', left: 3600, line: 3240 },
+              { type: :ordered,   level: 5, format: 'lowerRoman',  value: '%6.', left: 4320, line: 3960, align: :right },
+              { type: :ordered,   level: 6, format: 'decimal',     value: '%7.', left: 5040, line: 4680 },
+              { type: :ordered,   level: 7, format: 'lowerLetter', value: '%8.', left: 5760, line: 5400 },
+              { type: :ordered,   level: 8, format: 'lowerRoman',  value: '%9.', left: 6480, line: 6120, align: :right },
+              
+              { type: :unordered, level: 0, format: 'bullet',      value: '●',   left: 720,  line: 360  },
+              { type: :unordered, level: 1, format: 'bullet',      value: '○',   left: 1440, line: 1080 },
+              { type: :unordered, level: 2, format: 'bullet',      value: '■',   left: 2160, line: 1800 },
+              { type: :unordered, level: 3, format: 'bullet',      value: '●',   left: 2880, line: 2520 },
+              { type: :unordered, level: 4, format: 'bullet',      value: '○',   left: 3600, line: 3240 },
+              { type: :unordered, level: 5, format: 'bullet',      value: '■',   left: 4320, line: 3960 },
+              { type: :unordered, level: 6, format: 'bullet',      value: '●',   left: 5040, line: 4680 },
+              { type: :unordered, level: 7, format: 'bullet',      value: '○',   left: 5760, line: 5400 },
+              { type: :unordered, level: 8, format: 'bullet',      value: '■',   left: 6480, line: 6120 }
+            ]           
+          end
+          
+          
+          #-------------------------------------------------------------
+          # Public Methods
+          #-------------------------------------------------------------
+          
+          #============== ATTRIBUTES ==========================
+          
+          def list_style(**options, &block)
+            model = Caracal::Core::Models::ListStyleModel.new(options, &block)
+            
+            if model.valid?
+              register_list_style(model)
+            else
+              raise Caracal::Errors::InvalidModelError, 'list style must define a :type, :level, :format, and :value.'
+            end
+            model
+          end
+          
+          
+          #============== GETTERS =============================
+          
+          def list_styles
+            @list_styles ||= []
+          end
+          
+          def find_list_style(type, level)
+            list_styles.find { |s| s.matches?(type, level) }
+          end
+          
+          
+          #============== REGISTRATION ========================
+          
+          def register_list_style(model)
+            unregister_list_style(model.style_type, model.style_level)
+            list_styles << model
+            model
+          end
+          
+          def unregister_list_style(type, level)
+            if s = find_list_style(type, level)
+              list_styles.delete(s)
+            end
+          end
+          
+        end
+      end
+    end
+    
+  end
+end

data/lib/caracal/core/lists.rb

@@ -0,0 +1,57 @@
+require 'caracal/core/models/list_model'
+require 'caracal/errors'
+
+
+module Caracal
+  module Core
+    
+    # This module encapsulates all the functionality related to adding
+    # horizontal rules to the document.
+    #
+    module Lists
+      def self.included(base)
+        base.class_eval do
+          
+          #-------------------------------------------------------------
+          # Public Methods
+          #-------------------------------------------------------------
+          
+          #============== ATTRIBUTES ==========================
+          
+          def ol(**options, &block)
+            options.merge!({ type: :ordered, level: 0 })
+            
+            model = Caracal::Core::Models::ListModel.new(options, &block)
+            if model.valid?
+              contents << model
+            else
+              raise Caracal::Errors::InvalidModelError, 'Ordered lists require at least one list item.'
+            end
+            model
+          end
+          
+          def ul(**options, &block)
+            options.merge!({ type: :unordered, level: 0 })
+            
+            model = Caracal::Core::Models::ListModel.new(options, &block)
+            if model.valid?
+              contents << model
+            else
+              raise Caracal::Errors::InvalidModelError, 'Unordered lists require at least one list item.'
+            end
+            model
+          end
+          
+          
+          #============== GETTERS ==========================
+          
+          def toplevel_lists
+            @toplevel_lists ||= []
+          end
+          
+        end
+      end
+    end
+    
+  end
+end

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

@@ -0,0 +1,51 @@
+module Caracal
+  module Core
+    module Models
+      
+      # This class encapsulates the logic needed for functions that 
+      # do not store or manipulate data.
+      #
+      class BaseModel
+        
+        #-------------------------------------------------------------
+        # Configuration
+        #-------------------------------------------------------------
+    
+        # initialization
+        def initialize(**options, &block)
+          options.keep_if { |k,v| option_keys.include? k }
+          options.each do |(key, value)|
+            send(key, value)
+          end
+          
+          if block_given?
+            (block.arity < 1) ? instance_eval(&block) : block[self]
+          end
+        end
+        
+        
+        #-------------------------------------------------------------
+        # Public Instance Methods
+        #-------------------------------------------------------------
+    
+        #=============== VALIDATION ===========================
+        
+        def valid?
+          true
+        end
+        
+        
+        #-------------------------------------------------------------
+        # Private Instance Methods
+        #-------------------------------------------------------------
+        private
+        
+        def option_keys
+          []
+        end
+        
+      end
+      
+    end
+  end
+end