caracal_the_curve 1.4.1

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/caracal.gemspec

@@ -0,0 +1,28 @@
+# 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_the_curve'
+  spec.version       = Caracal::VERSION
+  spec.authors       = ['Trade Infomatics', 'John Dugan']
+  spec.email         = ['jpdugan@gmail.com']
+  spec.summary       = %q{ Fast, professional Microsoft Word (docx) writer for Ruby. }
+  spec.description   = %q{ Caracal is a pure Ruby Microsoft Word generation library that produces professional quality MSWord documents (docx) 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.0', '< 3.0']
+  spec.add_dependency 'tilt',     '>= 1.4'
+
+  spec.add_development_dependency 'bundler',  '~> 2.4'
+  spec.add_development_dependency 'rake',     '~> 10.0'
+  spec.add_development_dependency 'rspec',    '~> 3.0'
+end

data/lib/caracal/core/bookmarks.rb

@@ -0,0 +1,52 @@
+require 'caracal/core/models/bookmark_model'
+require 'caracal/errors'
+
+
+module Caracal
+  module Core
+
+    # This module encapsulates all the functionality related to adding
+    # bookmarks to the document.
+    #
+    module Bookmarks
+      def self.included(base)
+        base.class_eval do
+
+          #------------------------------------------------
+          # Public 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?
+              contents << 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?
+              contents << model
+            else
+              raise Caracal::Errors::InvalidModelError, 'Bookmark ending tags require an id.'
+            end
+            model
+          end
+          
+        end
+      end
+    end
+
+  end
+end

data/lib/caracal/core/custom_properties.rb

@@ -0,0 +1,49 @@
+require 'caracal/core/models/custom_property_model'
+require 'caracal/errors'
+
+
+module Caracal
+  module Core
+
+    # This module encapsulates all the functionality related to setting the
+    # document's custom properties.
+    #
+    module CustomProperties
+      def self.included(base)
+        base.class_eval do
+
+          #-------------------------------------------------------------
+          # Public Methods
+          #-------------------------------------------------------------
+
+          # This method controls the custom properties.
+          #
+          def custom_property(options={}, &block)
+            model = Caracal::Core::Models::CustomPropertyModel.new(options, &block)
+            if model.valid?
+              register_property(model)
+            end
+            model
+          end
+
+
+          #============== GETTERS =============================
+
+          def custom_props
+            @custom_props ||= []
+          end
+
+
+          #============== REGISTRATION ========================
+
+          def register_property(model)
+            custom_props << model
+            model
+          end
+
+        end
+      end
+    end
+
+  end
+end

data/lib/caracal/core/file_name.rb

@@ -0,0 +1,43 @@
+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
+          attr_reader :path
+
+
+          #-------------------------------------------------------------
+          # 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
+            a = v.split('/')
+
+            @name = (v == '') ? self.class::DEFAULT_FILE_NAME : a.last
+            @path = (a.size > 1) ? v : "./#{ 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(options={}, &block)
+            model = Caracal::Core::Models::FontModel.new(options, &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/iframes.rb

@@ -0,0 +1,42 @@
+require 'caracal/core/models/iframe_model'
+require 'caracal/errors'
+
+
+module Caracal
+  module Core
+
+    # This module encapsulates all the functionality related to inserting
+    # word document snippets into the document.
+    #
+    module IFrames
+      def self.included(base)
+        base.class_eval do
+
+          #-------------------------------------------------------------
+          # Public Methods
+          #-------------------------------------------------------------
+
+          def iframe(options={}, &block)
+            model = Caracal::Core::Models::IFrameModel.new(options, &block)
+            if model.valid?
+              model.preprocess!
+              model.namespaces.each do |(prefix, href)|
+                namespace({ prefix: prefix, href: href })
+              end
+              model.ignorables.each do |prefix|
+                ignorable(prefix)
+              end
+
+              contents << model
+            else
+              raise Caracal::Errors::InvalidModelError, 'IFrameModel requires either the :url or :data argument.'
+            end
+            model
+          end
+
+        end
+      end
+    end
+
+  end
+end

data/lib/caracal/core/ignorables.rb

@@ -0,0 +1,47 @@
+module Caracal
+  module Core
+
+    # This module encapsulates all the functionality related to registering and
+    # retrieving ignorable namespaces.
+    #
+    module Ignorables
+      def self.included(base)
+        base.class_eval do
+
+          #-------------------------------------------------------------
+          # Public Methods
+          #-------------------------------------------------------------
+
+          #============== ATTRIBUTES ==========================
+
+          def ignorable(prefix)
+            register_ignorable(prefix)
+          end
+
+
+          #============== GETTERS =============================
+
+          def ignorables
+            @ignorables ||= []
+          end
+
+
+          #============== REGISTRATION ========================
+
+          def register_ignorable(prefix)
+            unless ignorables.include?(prefix)
+              ignorables << prefix
+              prefix
+            end
+          end
+
+          def unregister_ignorable(prefix)
+            ignorables.delete(prefix)
+          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(*args, &block)
+            options = Caracal::Utilities.extract_options!(args)
+            options.merge!({ url: args.first }) if args.first
+            
+            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/list_styles.rb

@@ -0,0 +1,93 @@
+# encoding: utf-8
+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,  indent: 360  },
+              { type: :ordered,   level: 1, format: 'lowerLetter', value: '%2.', left: 1440, indent: 1080 },
+              { type: :ordered,   level: 2, format: 'lowerRoman',  value: '%3.', left: 2160, indent: 1800, align: :right },
+              { type: :ordered,   level: 3, format: 'decimal',     value: '%4.', left: 2880, indent: 2520 },
+              { type: :ordered,   level: 4, format: 'lowerLetter', value: '%5.', left: 3600, indent: 3240 },
+              { type: :ordered,   level: 5, format: 'lowerRoman',  value: '%6.', left: 4320, indent: 3960, align: :right },
+              { type: :ordered,   level: 6, format: 'decimal',     value: '%7.', left: 5040, indent: 4680 },
+              { type: :ordered,   level: 7, format: 'lowerLetter', value: '%8.', left: 5760, indent: 5400 },
+              { type: :ordered,   level: 8, format: 'lowerRoman',  value: '%9.', left: 6480, indent: 6120, align: :right },
+                                                                                             
+              { type: :unordered, level: 0, format: 'bullet',      value: '●',   left: 720,  indent: 360  },
+              { type: :unordered, level: 1, format: 'bullet',      value: '○',   left: 1440, indent: 1080 },
+              { type: :unordered, level: 2, format: 'bullet',      value: '■',   left: 2160, indent: 1800 },
+              { type: :unordered, level: 3, format: 'bullet',      value: '●',   left: 2880, indent: 2520 },
+              { type: :unordered, level: 4, format: 'bullet',      value: '○',   left: 3600, indent: 3240 },
+              { type: :unordered, level: 5, format: 'bullet',      value: '■',   left: 4320, indent: 3960 },
+              { type: :unordered, level: 6, format: 'bullet',      value: '●',   left: 5040, indent: 4680 },
+              { type: :unordered, level: 7, format: 'bullet',      value: '○',   left: 5760, indent: 5400 },
+              { type: :unordered, level: 8, format: 'bullet',      value: '■',   left: 6480, indent: 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

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

@@ -0,0 +1,86 @@
+require 'caracal/core/models/base_model'
+
+
+module Caracal
+  module Core
+    module Models
+
+      # This class encapsulates the logic needed to store and manipulate
+      # bookmarks.
+      #
+      class BookmarkModel < BaseModel
+
+        #--------------------------------------------------
+        # Configuration
+        #--------------------------------------------------
+
+        # accessors
+        attr_reader :bookmark_start
+        attr_reader :bookmark_id
+        attr_reader :bookmark_name
+
+
+        #--------------------------------------------------
+        # Public Methods
+        #--------------------------------------------------
+
+        #========== GETTERS ===============================
+
+        # .run_attributes
+        def run_attributes
+          {
+            start:          bookmark_start,
+            id:             bookmark_id,
+            name:           bookmark_name
+          }
+        end
+
+
+        #========== SETTERS ===============================
+
+        # booleans
+        [:start].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@bookmark_#{ m }", !!value)
+          end
+        end
+
+        # strings
+        [:id, :name].each do |m|
+          define_method "#{ m }" do |value|
+            instance_variable_set("@bookmark_#{ m }", value.to_s)
+          end
+        end
+
+
+        #========== STATE HELPERS =========================
+
+        def start?
+          !!bookmark_start
+        end
+
+
+        #========== VALIDATION ============================
+
+        def valid?
+          a  = [:id]
+          a << :name  if start?
+
+          a.map { |m| send("bookmark_#{ m }") }.compact.size == a.size
+        end
+
+
+        #--------------------------------------------------
+        # Private Methods
+        #--------------------------------------------------
+        private
+
+        def option_keys
+          [:id, :name, :start]
+        end
+
+      end
+
+    end
+  end
+end