caracal 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa886d1701a3fd3be57df67220f491dc020759ff
-  data.tar.gz: 0819776425e4c055c74946f6cf9c73622b8964cd
+  metadata.gz: c858148d5ae537806007e2e90609ef72cb78aaad
+  data.tar.gz: e92af27b1c79d1842ed2aac515aedfe0452bb53c
 SHA512:
-  metadata.gz: 01bbb4a1ea7264b9f95363005af6acaa76796a1085a6ef3264645b4cd29f586a79bddcf87d458ae69d63fefd3570908367e7982cdf1705d608d5ab15dd593482
-  data.tar.gz: 8d116facbd2f0a0c7de17a85cf6694ffca5d8fd88799ccfd20159dbb13402f2e9ef6f57979d6982d2e462682749a93364e0323544602176396a1ce3a3a0c54c1
+  metadata.gz: 42047a3d1dc77994ef4bf3f733c5634e6d1dbeec590a7895e9d299a8ae93ac565a6c974b9577f87f4e612936e70ace9fc9c2b7063a42d7b858e8fc10e0724b3b
+  data.tar.gz: 795fde5d5a5561e750ccb90953a763b173a48a55a7179197d1eb186203d585c704ba2ed728276a25e2c56dd8d2d67961ee2d81af351655e062110f129abb9f4f

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+#### v1.0.3
+
+* Enhancements
+  * Added custom properties (@davidtolsma).
+  * Added page breaks to paragraph model sub-functions (@jdugan).
+
+
 #### v1.0.2
 
 * Enhancements
@@ -7,7 +14,7 @@
 #### v0.3.0
 
 * Deprecations
-  * The :style attribute is no longer allowed on text and link commands. Use :font, :size, etc. instead.
+  * The :style attribute is no longer allowed on text and link commands. Use :font, :size, etc. instead (@jdugan).
 
 
 #### v0.2.1
@@ -22,15 +29,14 @@
 * Enhancements
 	* Implemented true line breaks within paragraphs (@Linuus).
 	* Converted paragraph command to accept/allow blank content (@Linuus).
-	* Allowed :top and :bottom attributes to be set on default paragraph style (@jpdugan).
+	* Allowed :top and :bottom attributes to be set on default paragraph style (@jdugan).
 
 
 * Deprecations
-	* Line breaks are no longer allowed at the document level. Use blank paragraphs instead.
-
+	* Line breaks are no longer allowed at the document level. Use blank paragraphs instead (@jdugan).
 
 
 #### v0.1.x
 
 * Enhancements
-	* Initial commits. (@jpdugan)
+	* Initial commits. (@jdugan)

data/README.md

@@ -90,6 +90,7 @@ For each Caracal request, the following document structure will be created and z
       |- docProps
         |- app.xml
         |- core.xml
+        |- custom.xml
       |- word
         |- _rels
           |- document.xml.rels
@@ -119,6 +120,9 @@ Specifies the name of the application that generated the document. *This file is
 **docProps/core.xml**
 Specifies the title of the document. *This file is generated automatically by the library based on other user directives.*
 
+**docProps/custom.xml**
+Specifies the custom document properties. *This file is generated automatically by the library based on other user directives.*
+
 **word/_rels/document.xml.rels**
 Defines an internal identifier and type with all external content items (images, links, etc). *This file is generated automatically by the library based on other user directives.*
 
@@ -167,14 +171,14 @@ A twip is 1/20 of a point.  Word documents are printed at 72dpi.  1in == 72pt ==
 In Word documents, pixels are equivalent to points.
 
 **EMUs (English Metric Unit)**
-EMUs are a virtual unit designed to facilitate the smooth conversion between inches, milliimeters, and pixels for images and vector graphics.  1in == 914400 EMUs == 72dpi x 100 x 254.
+EMUs are a virtual unit designed to facilitate the smooth conversion between inches, millimeters, and pixels for images and vector graphics.  1in == 914400 EMUs == 72dpi x 100 x 254.
 
 At present, Caracal expects values to be specified in whichever unit OOXML requires. This is admittedly difficult for new Caracal users. Eventually, we'll probably implement a utility object under the hood to convert user-specified units into the format expected by OOXML.
 
 
 ## Syntax Flexibility
 
-Generally speaking, Caracal commands will accept instructions via any combination of a parameters hash and/or a block.  For example, all of the folowing commands are equivalent.
+Generally speaking, Caracal commands will accept instructions via any combination of a parameters hash and/or a block.  For example, all of the following commands are equivalent.
 
 ```ruby
 docx.style id: 'special', name: 'Special', size: 24, bold: true
@@ -351,9 +355,28 @@ Caracal establishes a standard set of default styles for every document. Default
 * Heading6
 
 
+
+### Custom Properties
+
+Custom document properties can be defined using the `custom_property` method.  The method accepts a few required parameters to control the definition of the custom property.
+
+```ruby
+docx.custom_property do
+  name      'property name 1' # sets the name of the custom property.
+  value     'test'            # sets the value of the custom property.
+  type      :text             # sets the property type. accepts :text, :number, :date, :boolean.
+end
+```
+
+The `name`, `value`, and `height` attributes are required. If any of the attributes are missing, the custom property will not be created.
+
+A document may have zero or many custom properties. Each custom property's `name` should be unique with its `type`.
+
+
+
 ### Paragraphs
 
-Paragraph text can be added using the `p` method.  The method accepts several optional parameters for controlling the style and behavior of the paragrpah.
+Paragraph text can be added using the `p` method.  The method accepts several optional parameters for controlling the style and behavior of the paragraph.
 
 In its simple form, a paragraph accepts a text string and formatting options.
 
@@ -364,7 +387,7 @@ docx.p 'Sample text.', style: 'custom_style'
 
 docx.p 'Sample text.' do
   style     'custom_style'    # sets the paragraph style. generally used at the exclusion of other attributes.
-  align     :left             # sewts the alignment. accepts :left, :center, :right, and :both.
+  align     :left             # sets the alignment. accepts :left, :center, :right, and :both.
   color     '333333'          # sets the font color.
   size      32                # sets the font size. units in 1/2 points.
   bold      true              # sets whether or not to render the text with a bold weight.
@@ -384,6 +407,7 @@ docx.p do
   text '.'
   br
   text 'This text follows a line break.'
+  page
 end
 ```
 
@@ -565,7 +589,7 @@ docx.table [['Header 1','Header 2'],['Cell 1', 'Cell 2']] do
   border_color   '666666'   # sets the border color. defaults to 'auto'.
   border_line    :single    # sets the border style. defaults to :single. see OOXML docs for details.
   border_size    4          # sets the border width. defaults to 0. units in twips.
-  border_spacing 4          # sets the spacing around the border. deaults to 0. units in twips.
+  border_spacing 4          # sets the spacing around the border. defaults to 0. units in twips.
 end
 ```
 

data/lib/caracal/core/custom_properties.rb

@@ -0,0 +1,47 @@
+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/models/custom_property_model.rb

@@ -0,0 +1,60 @@
+require 'caracal/core/models/base_model'
+
+
+module Caracal
+  module Core
+    module Models
+
+      # This class encapsulates the logic needed to store and manipulate
+      # custom properties
+      #
+      class CustomPropertyModel < BaseModel
+
+        # accessors
+        attr_reader :custom_property_name
+        attr_reader :custom_property_value
+        attr_reader :custom_property_type
+
+
+        #-------------------------------------------------------------
+        # Public Instance Methods
+        #-------------------------------------------------------------
+
+
+        #=================== SETTERS =============================
+
+        def name(value)
+          @custom_property_name = value.to_s
+        end
+
+        def value(value)
+          @custom_property_value = value.to_s
+        end
+
+        def type(value)
+          @custom_property_type = value.to_s
+        end
+
+
+        #=============== VALIDATION ===========================
+
+        def valid?
+          required = option_keys
+          required.all? { |m| !send("custom_property_#{ m }").nil? }
+        end
+
+        
+        #-------------------------------------------------------------
+        # Private Instance Methods
+        #-------------------------------------------------------------
+        private
+
+        def option_keys
+          [:name, :value, :type]
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -4,12 +4,58 @@ 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.
       #
-      class PageBreakModel < BaseModel; end
-      
+      # 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
+end

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

@@ -92,6 +92,13 @@ module Caracal
 
         #=============== SUB-METHODS ===========================
 
+        # .br
+        def br
+          model = Caracal::Core::Models::LineBreakModel.new()
+          runs << model
+          model
+        end
+
         # .link
         def link(*args, &block)
           options = Caracal::Utilities.extract_options!(args)
@@ -107,9 +114,9 @@ module Caracal
           model
         end
 
-        # .br
-        def br
-          model = Caracal::Core::Models::LineBreakModel.new()
+        # .page
+        def page
+          model = Caracal::Core::Models::PageBreakModel.new({ wrap: false })
           runs << model
           model
         end

data/lib/caracal/document.rb

@@ -9,6 +9,7 @@ require 'caracal/core/lists'
 require 'caracal/core/page_breaks'
 require 'caracal/core/page_numbers'
 require 'caracal/core/page_settings'
+require 'caracal/core/custom_properties'
 require 'caracal/core/relationships'
 require 'caracal/core/rules'
 require 'caracal/core/styles'
@@ -18,6 +19,7 @@ require 'caracal/core/text'
 require 'caracal/renderers/app_renderer'
 require 'caracal/renderers/content_types_renderer'
 require 'caracal/renderers/core_renderer'
+require 'caracal/renderers/custom_renderer'
 require 'caracal/renderers/document_renderer'
 require 'caracal/renderers/fonts_renderer'
 require 'caracal/renderers/footer_renderer'
@@ -30,97 +32,98 @@ require 'caracal/renderers/styles_renderer'
 
 module Caracal
   class Document
-    
+
     #-------------------------------------------------------------
     # Configuration
     #-------------------------------------------------------------
-    
+
     # mixins (order is important)
     include Caracal::Core::FileName
-    
+    include Caracal::Core::CustomProperties
+
     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::Lists
     include Caracal::Core::PageBreaks
     include Caracal::Core::Rules
     include Caracal::Core::Tables
     include Caracal::Core::Text
-    
-    
+
+
     #-------------------------------------------------------------
     # Public Class Methods
     #-------------------------------------------------------------
-    
+
     #============ 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_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
-    
-    
+
+
     #============ GETTERS ===================================
-    
-    # This method returns an array of models which constitute the 
+
+    # This method returns an array of models which constitute the
     # set of instructions for producing the document content.
     #
     def contents
       @contents ||= []
     end
-    
-    
+
+
     #============ RENDERING =================================
-    
-    # This method renders the word document instance into 
+
+    # This method renders the word document instance into
     # a string buffer. Order is important!
     #
     def render
@@ -129,6 +132,7 @@ module Caracal
         render_content_types(zip)
         render_app(zip)
         render_core(zip)
+        render_custom(zip)
         render_fonts(zip)
         render_footer(zip)
         render_settings(zip)
@@ -139,58 +143,65 @@ module Caracal
         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_custom(zip)
+      content = ::Caracal::Renderers::CustomRenderer.render(self)
+
+      zip.put_next_entry('docProps/custom.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|
@@ -199,46 +210,46 @@ module Caracal
         else
           content = open(rel.relationship_target).read
         end
-        
+
         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

data/lib/caracal/renderers/content_types_renderer.rb

@@ -6,12 +6,12 @@ require 'caracal/renderers/xml_renderer'
 module Caracal
   module Renderers
     class ContentTypesRenderer < XmlRenderer
-      
+
       #-------------------------------------------------------------
       # Public Methods
       #-------------------------------------------------------------
-      
-      # This method produces the xml required for the `_[ContentTypes].xml` 
+
+      # This method produces the xml required for the `_[ContentTypes].xml`
       # sub-document.
       #
       def to_xml
@@ -23,31 +23,32 @@ module Caracal
             xml.send 'Default', { 'Extension' => 'png',  'ContentType' => 'image/png' }
             xml.send 'Default', { 'Extension' => 'rels', 'ContentType' => 'application/vnd.openxmlformats-package.relationships+xml' }
             xml.send 'Default', { 'Extension' => 'xml',  'ContentType' => 'application/xml' }
-            xml.send 'Override', { 'PartName' => '/docProps/app.xml',   'ContentType' => 'application/vnd.openxmlformats-officedocument.extended-properties+xml' }
-            xml.send 'Override', { 'PartName' => '/docProps/core.xml',  'ContentType' => 'application/vnd.openxmlformats-package.core-properties+xml' }
-            xml.send 'Override', { 'PartName' => '/word/document.xml',  'ContentType' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml' }
-            xml.send 'Override', { 'PartName' => '/word/footer1.xml',   'ContentType' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.footer+xml' }
-            xml.send 'Override', { 'PartName' => '/word/fontTable.xml', 'ContentType' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.fontTable+xml' }
-            xml.send 'Override', { 'PartName' => '/word/numbering.xml', 'ContentType' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.numbering+xml' }
-            xml.send 'Override', { 'PartName' => '/word/settings.xml',  'ContentType' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.settings+xml' }
-            xml.send 'Override', { 'PartName' => '/word/styles.xml',    'ContentType' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.styles+xml' }
+            xml.send 'Override', { 'PartName' => '/docProps/app.xml',    'ContentType' => 'application/vnd.openxmlformats-officedocument.extended-properties+xml' }
+            xml.send 'Override', { 'PartName' => '/docProps/core.xml',   'ContentType' => 'application/vnd.openxmlformats-package.core-properties+xml' }
+            xml.send 'Override', { 'PartName' => '/docProps/custom.xml', 'ContentType' => 'application/vnd.openxmlformats-officedocument.custom-properties+xml' }
+            xml.send 'Override', { 'PartName' => '/word/document.xml',   'ContentType' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml' }
+            xml.send 'Override', { 'PartName' => '/word/footer1.xml',    'ContentType' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.footer+xml' }
+            xml.send 'Override', { 'PartName' => '/word/fontTable.xml',  'ContentType' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.fontTable+xml' }
+            xml.send 'Override', { 'PartName' => '/word/numbering.xml',  'ContentType' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.numbering+xml' }
+            xml.send 'Override', { 'PartName' => '/word/settings.xml',   'ContentType' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.settings+xml' }
+            xml.send 'Override', { 'PartName' => '/word/styles.xml',     'ContentType' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.styles+xml' }
           end
         end
         builder.to_xml(save_options)
       end
-      
-      
+
+
       #-------------------------------------------------------------
       # Private Methods
-      #------------------------------------------------------------- 
+      #-------------------------------------------------------------
       private
-      
+
       def root_options
         {
           'xmlns' => 'http://schemas.openxmlformats.org/package/2006/content-types'
         }
       end
-   
+
     end
   end
-end
+end

data/lib/caracal/renderers/custom_renderer.rb

@@ -0,0 +1,64 @@
+require 'nokogiri'
+require 'date'
+
+require 'caracal/renderers/xml_renderer'
+
+
+module Caracal
+  module Renderers
+    class CustomRenderer < XmlRenderer
+
+      #-------------------------------------------------------------
+      # Public Methods
+      #-------------------------------------------------------------
+
+      # This method produces the xml required for the `docProps/custom.xml`
+      # sub-document.
+      #
+      def to_xml
+        builder = ::Nokogiri::XML::Builder.with(declaration_xml) do |xml|
+          xml.send 'Properties', root_options do
+            document.custom_props.each_with_index do |property, index|
+              xml.send 'property',
+                { fmtid: '{D5CDD505-2E9C-101B-9397-08002B2CF9AE}', pid: index + 2, name: property.custom_property_name } do
+                  case property.custom_property_type.downcase
+                  when  'text'
+                    xml['vt'].lpwstr property.custom_property_value
+                  when 'date'
+                    xml['vt'].filetime property.custom_property_value.to_date
+                  when 'number'
+                    xml['vt'].i4 property.custom_property_value.to_f
+                  when 'boolean'
+                    if property.custom_property_value == 'true' || property.custom_property_value == 'false'
+                      xml['vt'].bool property.custom_property_value
+                    else
+                      # Not a boolean sent, so reverting to string so docx will open
+                      xml['vt'].lpwstr property.custom_property_value
+                    end
+                  else
+                    # Fail to string type
+                    xml['vt'].lpwstr property.custom_property_value
+                end
+              end
+            end
+          end
+        end
+        builder.to_xml(save_options)
+      end
+
+
+      #-------------------------------------------------------------
+      # Private Methods
+      #-------------------------------------------------------------
+      private
+
+      def root_options
+        {
+          'xmlns'        => "http://schemas.openxmlformats.org/officeDocument/2006/custom-properties",
+          'xmlns:vt'     => "http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes"
+        }
+      end
+
+    end
+  end
+end

data/lib/caracal/renderers/document_renderer.rb

@@ -205,7 +205,13 @@ module Caracal
       end
 
       def render_pagebreak(xml, model)
-        xml.send 'w:p', paragraph_options do
+        if model.page_break_wrap
+          xml.send 'w:p', paragraph_options do
+            xml.send 'w:r', run_options do
+              xml.send 'w:br', { 'w:type' => 'page' }
+            end
+          end
+        else
           xml.send 'w:r', run_options do
             xml.send 'w:br', { 'w:type' => 'page' }
           end

data/lib/caracal/renderers/package_relationships_renderer.rb

@@ -6,12 +6,12 @@ require 'caracal/renderers/xml_renderer'
 module Caracal
   module Renderers
     class PackageRelationshipsRenderer < XmlRenderer
-      
+
       #-------------------------------------------------------------
       # Public Methods
       #-------------------------------------------------------------
-      
-      # This method produces the xml required for the `word/settings.xml` 
+
+      # This method produces the xml required for the `word/settings.xml`
       # sub-document.
       #
       def to_xml
@@ -24,27 +24,28 @@ module Caracal
         end
         builder.to_xml(save_options)
       end
-      
-      
+
+
       #-------------------------------------------------------------
       # Private Methods
-      #------------------------------------------------------------- 
+      #-------------------------------------------------------------
       private
-      
+
       def relationship_data
         [
-          ['docProps/app.xml',  'http://schemas.openxmlformats.org/officeDocument/2006/relationships/extended-properties'],
-          ['docProps/core.xml', 'http://schemas.openxmlformats.org/package/2006/relationships/metadata/core-properties'],
-          ['word/document.xml', 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument']
+          ['docProps/app.xml',    'http://schemas.openxmlformats.org/officeDocument/2006/relationships/extended-properties'],
+          ['docProps/core.xml',   'http://schemas.openxmlformats.org/package/2006/relationships/metadata/core-properties'],
+          ['docProps/custom.xml', 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/custom-properties'],
+          ['word/document.xml',   'http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument']
         ]
       end
-      
+
       def root_options
         {
           'xmlns' => 'http://schemas.openxmlformats.org/package/2006/relationships'
         }
       end
-   
+
     end
   end
-end
+end

data/lib/caracal/renderers/xml_renderer.rb

@@ -4,80 +4,80 @@ require 'nokogiri'
 module Caracal
   module Renderers
     class XmlRenderer
-      
+
       #-------------------------------------------------------------
       # Configuration
       #-------------------------------------------------------------
-      
+
       attr_reader :document
-      
-      
+
+
       #-------------------------------------------------------------
       # Class Methods
       #-------------------------------------------------------------
-      
-      # This method produces xml output for the given document 
+
+      # This method produces xml output for the given document
       # according to the rules of this renderer object.
       #
       def self.render(doc)
         renderer = new(doc)
         renderer.to_xml
       end
-      
-      
+
+
       #-------------------------------------------------------------
       # Public Methods
       #-------------------------------------------------------------
-    
+
       # This method instantiates a new verison of this renderer.
       #
       def initialize(doc)
         unless doc.is_a?(Caracal::Document)
           raise NoDocumentError, 'renderers must receive a reference to a valid Caracal document object.'
         end
-        
+
         @document = doc
       end
-      
+
       # This method converts data in the specified document to XML.
       # A concrete implementation must be provided by the subclass.
       #
       def to_xml
         raise NotImplementedError, 'renderers must implement the method :to_xml.'
       end
-   
-   
+
+
       #-------------------------------------------------------------
       # Private Methods
       #-------------------------------------------------------------
       private
-      
-      # This method returns a Nokogiri::XML object that contains the 
+
+      # This method returns a Nokogiri::XML object that contains the
       # specific declaration we want.
       #
       def declaration_xml
         ::Nokogiri::XML('<?xml version = "1.0" encoding = "UTF-8" standalone ="yes"?>')
       end
-      
+
       # This method returns a commonly used set of attributes for paragraph nodes.
       #
       def paragraph_options
         { 'w:rsidP' => '00000000', 'w:rsidRDefault' => '00000000' }.merge(run_options)
       end
-      
+
       # This method returns a commonly used set of attributes for text run nodes.
       #
       def run_options
         { 'w:rsidR' => '00000000', 'w:rsidRPr' => '00000000', 'w:rsidDel' => '00000000' }
       end
-      
+
       # These save options force Nokogiri to remove indentation and
       # line feeds from the output.
       #
       def save_options
         { save_with: Nokogiri::XML::Node::SaveOptions::AS_XML }
       end
-      
+
     end
   end
-end
+end

data/lib/caracal/version.rb

@@ -1,3 +1,3 @@
 module Caracal
-  VERSION = '1.0.2'
+  VERSION = '1.0.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: caracal
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Trade Infomatics
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-09 00:00:00.000000000 Z
+date: 2016-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -112,6 +112,7 @@ files:
 - Rakefile
 - caracal.gemspec
 - lib/caracal.rb
+- lib/caracal/core/custom_properties.rb
 - lib/caracal/core/file_name.rb
 - lib/caracal/core/fonts.rb
 - lib/caracal/core/images.rb
@@ -119,6 +120,7 @@ files:
 - lib/caracal/core/lists.rb
 - lib/caracal/core/models/base_model.rb
 - lib/caracal/core/models/border_model.rb
+- lib/caracal/core/models/custom_property_model.rb
 - lib/caracal/core/models/font_model.rb
 - lib/caracal/core/models/image_model.rb
 - lib/caracal/core/models/line_break_model.rb
@@ -150,6 +152,7 @@ files:
 - lib/caracal/renderers/app_renderer.rb
 - lib/caracal/renderers/content_types_renderer.rb
 - lib/caracal/renderers/core_renderer.rb
+- lib/caracal/renderers/custom_renderer.rb
 - lib/caracal/renderers/document_renderer.rb
 - lib/caracal/renderers/fonts_renderer.rb
 - lib/caracal/renderers/footer_renderer.rb