openxml-docx 0.9.0 → 0.10.0

data/lib/openxml/docx/elements/word_processing_drawing_position_v.rb

@@ -0,0 +1,23 @@
+module OpenXml
+  module Docx
+    module Elements
+      class WordProcessingDrawingPositionV < Container
+        tag :positionV
+        namespace :wp
+
+        attribute :relativeFrom, expects: :valid_relative_from
+
+      private
+
+        def valid_relative_from(value)
+          raise ArgumentError unless ok_values.include? value
+        end
+
+        def ok_values
+          %i(bottomMargin insideMargin line margin outsideMargin page
+          paragraph topMargin)
+        end
+      end
+    end
+  end
+end

data/lib/openxml/docx/elements/word_processing_drawing_simple_position.rb

@@ -0,0 +1,13 @@
+module OpenXml
+  module Docx
+    module Elements
+      class WordProcessingDrawingSimplePosition < Element
+        tag :simplePos
+        namespace :wp
+
+        attribute :x, expects: :integer
+        attribute :y, expects: :integer
+      end
+    end
+  end
+end

data/lib/openxml/docx/elements/word_processing_drawing_wrap_none.rb

@@ -0,0 +1,10 @@
+module OpenXml
+  module Docx
+    module Elements
+      class WordProcessingDrawingWrapNone < Element
+        tag :wrapNone
+        namespace :wp
+      end
+    end
+  end
+end

data/lib/openxml/docx/elements/word_processing_shapes_body_properties.rb

@@ -0,0 +1,58 @@
+module OpenXml
+  module Docx
+    module Elements
+      class WordProcessingShapesBodyProperties < Container
+        tag :bodyPr
+        namespace :wps
+
+        attribute :anchor, expects: :anchor_value
+        attribute :anchorCtr, expects: :true_or_false
+        attribute :bottom_inset, expects: :positive_integer, displays_as: :bIns
+        attribute :compatible_line_spacing, expects: :true_or_false, displays_as: :compatLnSpc
+        attribute :force_anti_alias, expects: :true_or_false, displays_as: :forceAA
+        attribute :fromWordArt, expects: :true_or_false
+        attribute :horzOverflow, expects: :horizontal_overflow_value
+        attribute :left_inset, expects: :positive_integer, displays_as: :lIns
+        attribute :numCol, expects: :number_of_columns
+        attribute :right_inset, expects: :positive_integer, displays_as: :rIns
+        attribute :rotation, expects: :integer, displays_as: :rot
+        attribute :right_to_left_columns, expects: :true_or_false, displays_as: :rtlCol
+        attribute :space_between_columns, expects: :positive_integer, displays_as: :spcCol
+        attribute :paragraph_spacing, expects: :true_or_false, displays_as: :spcFirstLastPara
+        attribute :top_inset, expects: :positive_integer, displays_as: :tIns
+        attribute :upright, expects: :true_or_false
+        attribute :vert, expects: :vertical_value
+        attribute :vertOverflow, expects: :vertical_overflow_value
+        attribute :wrap, expects: :wrap_value
+
+      private
+
+        def anchor_value(value)
+          raise ArgumentError unless %i(b ctr dist just t).include? value
+        end
+
+        def horizontal_overflow_value(value)
+          raise ArgumentError unless %i(clip overflow).include? value
+        end
+
+        def number_of_columns(value)
+          raise ArgumentError unless (1..16).to_a.include? value
+        end
+
+        def vertical_value(value)
+          ok_values = %i(eaVert horz mongolianVert vert vert270 wordArt Vert wordArtVertRtl)
+          raise ArgumentError unless ok_values.include? value
+        end
+
+        def vertical_overflow_value(value)
+          raise ArgumentError unless %i(clip ellipsis overflow).include? value
+        end
+
+        def wrap_value(value)
+          raise ArgumentError unless %i(none square).include? value
+        end
+
+      end
+    end
+  end
+end

data/lib/openxml/docx/elements/word_processing_shapes_shape.rb

@@ -0,0 +1,12 @@
+module OpenXml
+  module Docx
+    module Elements
+      class WordProcessingShapesShape < Container
+        tag :wsp
+        namespace :wps
+
+        attribute :normalEastAsianFlow, expects: :true_or_false
+      end
+    end
+  end
+end

data/lib/openxml/docx/elements/word_processing_shapes_shape_properties.rb

@@ -0,0 +1,23 @@
+module OpenXml
+  module Docx
+    module Elements
+      class WordProcessingShapesShapeProperties < Container
+        tag :spPr
+        namespace :wps
+
+        attribute :bwMode, expects: :valid_colors
+
+      private
+
+        def valid_colors(value)
+          raise ArgumentError unless ok_values.include? value
+        end
+
+        def ok_values
+          %i(auto black blackGray blackWhite clr gray grayWhite hidden invGray ltGray white)
+        end
+
+      end
+    end
+  end
+end

data/lib/openxml/docx/package.rb

@@ -5,13 +5,19 @@ module OpenXml
     class Package < OpenXml::Package
       attr_reader :document,
                   :doc_rels,
+                  :font_rels,
                   :settings,
-                  :styles
+                  :headers,
+                  :footers,
+                  :styles,
+                  :fonts
 
       content_types do
         default "xml", TYPE_XML
+        default "odttf", TYPE_OBSCURED_FONT
         override "/word/styles.xml", TYPE_STYLES
         override "/word/settings.xml", TYPE_SETTINGS
+        override "/word/fontTable.xml", TYPE_FONT_TABLE
       end
 
       def initialize
@@ -19,17 +25,83 @@ module OpenXml
 
         rels.add_relationship REL_DOCUMENT, "/word/document.xml"
         @doc_rels = OpenXml::Parts::Rels.new
+        @font_rels = OpenXml::Parts::Rels.new
         @settings = OpenXml::Docx::Parts::Settings.new
         @styles = OpenXml::Docx::Parts::Styles.new
+        @fonts = OpenXml::Docx::Parts::Fonts.new
         @document = OpenXml::Docx::Parts::Document.new
+        @headers = []
+        @footers = []
 
         doc_rels.add_relationship REL_STYLES, "styles.xml"
         doc_rels.add_relationship REL_SETTINGS, "settings.xml"
+        doc_rels.add_relationship REL_FONT_TABLE, "fontTable.xml"
 
         add_part "word/_rels/document.xml.rels", doc_rels
+        add_part "word/_rels/fontTable.xml.rels", font_rels
         add_part "word/document.xml", document
         add_part "word/settings.xml", settings
         add_part "word/styles.xml", styles
+        add_part "word/fontTable.xml", fonts
+      end
+
+      def embed_truetype_font(path: nil, name: nil)
+        File.open(path, "rb") do |source_font|
+          obfuscation_data = obfuscate_font source_font
+          data = obfuscation_data[:bytes] << source_font.read
+          destination_font_name = "font#{fonts.fonts.count + 1}.odttf"
+          add_part "word/fonts/#{destination_font_name}", OpenXml::Parts::UnparsedPart.new(data)
+          font_relationship = font_rels.add_relationship REL_FONT, "fonts/#{destination_font_name}"
+
+          font_description = OpenXml::Docx::Elements::Font.new
+          font_description.font_name = name
+          embed_tag = OpenXml::Docx::Elements::EmbedRegular.new
+          embed_tag.font_key = "{#{obfuscation_data[:key]}}"
+          embed_tag.relationship_id = font_relationship.id
+          font_description << embed_tag
+          fonts << font_description
+        end
+      end
+
+      def add_header(header)
+        headers << header
+        header_name = "header#{headers.count}.xml"
+        Package.content_types { override "/word/#{header_name}", TYPE_HEADER }
+        add_part "word/#{header_name}", header
+        relationship = doc_rels.add_relationship REL_HEADER, header_name
+        relationship.id
+      end
+
+      def add_footer(footer)
+        footers << footer
+        footer_name = "footer#{footers.count}.xml"
+        Package.content_types { override "/word/#{footer_name}", TYPE_FOOTER }
+        add_part "word/#{footer_name}", footer
+        relationship = doc_rels.add_relationship REL_FOOTER, footer_name
+        relationship.id
+      end
+
+    private
+
+      def obfuscate_font(font)
+        # From the OpenXml spec, section 17.8.1, the algorithm for obfuscating a font:
+        # - Generate a GUID, which is used and stored as the obfuscation key
+        # - Reverse the order of the bytes in the GUID (i.e. Big Endian ordering)
+        # - XOR the value with the first 32 bytes of the binary: once against 0-15, once against 16-31
+        # - Store the resulting file in the document, and store the obfuscation key in the fontKey attribute
+
+        key = SecureRandom::uuid.upcase # Spec requires hex characters be uppercase
+        raw_key = key.gsub("-", "")
+        big_endian_key = [raw_key].pack("H*").bytes.reverse
+        obfuscated_bytes = []
+        2.times do
+          bytes = font.read(16).bytes
+          (0...16).each do |index|
+            obfuscated_bytes << (bytes[index] ^ big_endian_key[index])
+          end
+        end
+
+        { key: key, bytes: obfuscated_bytes.pack("C*") }
       end
 
     end

data/lib/openxml/docx/parts/document.rb

@@ -2,8 +2,13 @@ module OpenXml
   module Docx
     module Parts
       class Document < OpenXml::Part
+        include RootNamespaces
+
         attr_reader :children, :current_section
 
+        use_namespaces :wpc, :mo, :mv, :o, :r, :m, :v, :wp14, :wp, :w10, :w14, :wpg, :wpi, :wne, :wps, :w, :mc, :a14, :pic
+        can_ignore :w14, :wp14, :a14
+
         def initialize
           @children = []
         end
@@ -28,7 +33,7 @@ module OpenXml
         def to_xml
           build_xml do |xml|
             xml.document(root_namespaces) {
-              xml.parent.namespace = xml.parent.namespace_definitions.find { |ns| ns.prefix == "w" }
+              xml.parent.namespace = :w
               xml["w"].body {
                 children.each { |child| child.to_xml(xml) }
                 current_section.to_xml(xml) unless current_section.nil?
@@ -37,29 +42,6 @@ module OpenXml
           end
         end
 
-      private
-
-        def root_namespaces
-          { "xmlns:wpc" => 'http://schemas.microsoft.com/office/word/2010/wordprocessingCanvas',
-            "xmlns:mo" => 'http://schemas.microsoft.com/office/mac/office/2008/main',
-            "xmlns:mv" => 'urn:schemas-microsoft-com:mac:vml',
-            "xmlns:o" => 'urn:schemas-microsoft-com:office:office',
-            "xmlns:r" => 'http://schemas.openxmlformats.org/officeDocument/2006/relationships',
-            "xmlns:m" => 'http://schemas.openxmlformats.org/officeDocument/2006/math',
-            "xmlns:v" => 'urn:schemas-microsoft-com:vml',
-            "xmlns:wp14" => 'http://schemas.microsoft.com/office/word/2010/wordprocessingDrawing',
-            "xmlns:wp" => 'http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing',
-            "xmlns:w10" => 'urn:schemas-microsoft-com:office:word',
-            "xmlns:w14" => 'http://schemas.microsoft.com/office/word/2010/wordml',
-            "xmlns:wpg" => 'http://schemas.microsoft.com/office/word/2010/wordprocessingGroup',
-            "xmlns:wpi" => 'http://schemas.microsoft.com/office/word/2010/wordprocessingInk',
-            "xmlns:wne" => 'http://schemas.microsoft.com/office/word/2006/wordml',
-            "xmlns:wps" => 'http://schemas.microsoft.com/office/word/2010/wordprocessingShape',
-            "xmlns:w" => "http://schemas.openxmlformats.org/wordprocessingml/2006/main",
-            "xmlns:mc" => "http://schemas.openxmlformats.org/markup-compatibility/2006",
-            "mc:Ignorable" => "w14 wp14" }
-        end
-
       end
     end
   end

data/lib/openxml/docx/parts/fonts.rb

@@ -0,0 +1,35 @@
+module OpenXml
+  module Docx
+    module Parts
+      class Fonts < OpenXml::Part
+        include RootNamespaces
+
+        attr_reader :fonts
+
+        use_namespaces :r, :w
+
+        def initialize
+          @fonts = []
+        end
+
+        def <<(font)
+          @fonts << font
+        end
+
+        def count
+          fonts.count
+        end
+
+        def to_xml
+          build_standalone_xml do |xml|
+            xml.fonts(root_namespaces) {
+              xml.parent.namespace = :w
+              fonts.each { |font| font.to_xml(xml) }
+            }
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/openxml/docx/parts/footer.rb

@@ -0,0 +1,32 @@
+module OpenXml
+  module Docx
+    module Parts
+      class Footer < OpenXml::Part
+        include RootNamespaces
+
+        use_namespaces :wpc, :mo, :mv, :o, :r, :m, :v, :wp14, :wp, :w10, :w14, :w15, :wpg, :wpi, :wne, :wps, :w, :mc, :a, :a14
+        can_ignore :w14, :w15, :wp14, :a14
+
+        attr_reader :children
+
+        def initialize
+          @children = []
+        end
+
+        def <<(child)
+          children << child
+        end
+
+        def to_xml
+          build_xml do |xml|
+            xml.ftr(root_namespaces) {
+              xml.parent.namespace = :w
+              children.each { |child| child.to_xml(xml) }
+            }
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/openxml/docx/parts/header.rb

@@ -0,0 +1,32 @@
+module OpenXml
+  module Docx
+    module Parts
+      class Header < OpenXml::Part
+        include RootNamespaces
+
+        use_namespaces :wpc, :mo, :mv, :o, :r, :m, :v, :wp14, :wp, :w10, :w14, :w15, :wpg, :wpi, :wne, :wps, :w, :mc, :a, :a14
+        can_ignore :w14, :w15, :wp14, :a14
+
+        attr_reader :children
+
+        def initialize
+          @children = []
+        end
+
+        def <<(child)
+          children << child
+        end
+
+        def to_xml
+          build_xml do |xml|
+            xml.hdr(root_namespaces) {
+              xml.parent.namespace = :w
+              children.each { |child| child.to_xml(xml) }
+            }
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/openxml/docx/parts/settings.rb

@@ -2,6 +2,10 @@ module OpenXml
   module Docx
     module Parts
       class Settings < OpenXml::Part
+        include RootNamespaces
+
+        use_namespace :w
+
         attr_reader :settings
 
         def initialize
@@ -10,8 +14,8 @@ module OpenXml
 
         def to_xml
           build_standalone_xml do |xml|
-            xml.settings("xmlns:w" => "http://schemas.openxmlformats.org/wordprocessingml/2006/main") {
-              xml.parent.namespace = xml.parent.namespace_definitions.find { |ns| ns.prefix == "w" }
+            xml.settings(root_namespaces) {
+              xml.parent.namespace = :w
             }
           end
         end

data/lib/openxml/docx/parts/styles.rb

@@ -2,6 +2,10 @@ module OpenXml
   module Docx
     module Parts
       class Styles < OpenXml::Part
+        include RootNamespaces
+
+        use_namespaces :r, :w
+
         attr_reader :styles
 
         def initialize
@@ -15,7 +19,7 @@ module OpenXml
         def to_xml
           build_standalone_xml do |xml|
             xml.styles(root_namespaces) {
-              xml.parent.namespace = xml.parent.namespace_definitions.find { |ns| ns.prefix == "w" }
+              xml.parent.namespace = :w
               add_default_styles(xml)
               styles.each { |style| style.to_xml(xml) }
             }
@@ -39,11 +43,6 @@ module OpenXml
           }
         end
 
-        def root_namespaces
-          { "xmlns:r" => "http://schemas.openxmlformats.org/officeDocument/2006/relationships",
-            "xmlns:w" => "http://schemas.openxmlformats.org/wordprocessingml/2006/main" }
-        end
-
       end
     end
   end