openxml-docx 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1972ebd1b0c107bf2b90517f68e43451dd2ce03e
-  data.tar.gz: 98dccd8c85eee5358beb36727ec4a9d73f2c0631
+  metadata.gz: 721596bd0a99e7649d104985afa53b7152101fa6
+  data.tar.gz: e956ff4f80b2ce46f3022e5a05f92bb99e7057ef
 SHA512:
-  metadata.gz: 932d7911afa2eddb1611f2990a23fe4a6e5729f156d93a45a7c255e5e90eaabb5900d3c619b236320d838fe523676f959170f35b43b6c1b2ac894a12e2819a2f
-  data.tar.gz: 32f62f244add36189be452dd40eb7a5e5521e17139d22fd27562cce63149ae61df95e98dd3fd661d6adc601e0462efef10e8700059946a3eeb8e0a8373205201
+  metadata.gz: bbfecbf3a5aa07b90d1909c0642926dc025cafd08866f75b283768c3b7e0943b88a29737bcd92a0e4de90e29a1011f35d9fdc8514480157f1238d67c8b91caf5
+  data.tar.gz: a0aeb4b5b1032e62f3531498e9d3ffe4e27ef4e7834d41e80917fcb4edfa57c0eabbd4cfed81688245f8f30476a739f9da76d4bae7a38f7e9ea8f7ec78d0f8bc

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    openxml-docx (0.9.0)
+    openxml-docx (0.10.0)
       nokogiri
-      openxml-package (>= 0.2.1)
+      openxml-package (>= 0.2.2)
 
 GEM
   remote: https://rubygems.org/
@@ -16,7 +16,7 @@ GEM
     mini_portile2 (2.0.0)
     nokogiri (1.6.7)
       mini_portile2 (~> 2.0.0.rc2)
-    openxml-package (0.2.1)
+    openxml-package (0.2.2)
       nokogiri
       ox
       rubyzip (~> 1.1.0)
@@ -41,7 +41,7 @@ GEM
       rspec-support (~> 3.4.0)
     rspec-support (3.4.1)
     rubyzip (1.1.7)
-    simplecov (0.11.0)
+    simplecov (0.11.1)
       docile (~> 1.1.0)
       json (~> 1.8)
       simplecov-html (~> 0.10.0)

data/examples/drawing-ml

@@ -0,0 +1,134 @@
+#!/usr/bin/env ruby
+
+$:.push Dir.pwd + "/lib"
+require "openxml/docx"
+require "openxml/vml"
+
+include OpenXml::Docx::Elements
+
+document = OpenXml::Docx::Package.new
+
+table = Table.new
+table.table_width.type = :auto
+table.table_width.width = 0
+table.table_layout = :fixed
+
+table_cell_margins = OpenXml::Docx::Properties::TableCellMargins.new
+start_margin = OpenXml::Docx::Properties::TableCellMargin.new(:start)
+end_margin = OpenXml::Docx::Properties::TableCellMargin.new(:end)
+start_margin.type = :dxa
+start_margin.width = 86
+end_margin.type = :dxa
+end_margin.width = 86
+table_cell_margins << start_margin
+table_cell_margins << end_margin
+
+table << table_cell_margins
+
+table.table_look.firstColumn = false
+table.table_look.firstRow = false
+table.table_look.lastColumn = false
+table.table_look.lastRow = false
+table.table_look.noHBand = false
+table.table_look.noVBand = false
+
+table_grid = TableGrid.new
+[3787, 172, 3787, 172, 3787].each do |width|
+  grid_column = GridColumn.new
+  grid_column.w = width
+  table_grid << grid_column
+end
+
+table << table_grid
+
+table_row = TableRow.new
+table_row.table_row_height.hRule = :exact
+table_row.table_row_height.val = 1140
+
+table_cell = TableCell.new
+
+table_cell_width = OpenXml::Docx::Properties::TableCellWidth.new
+table_cell_width.type = :dxa
+table_cell_width.width = 0
+table_cell << table_cell_width
+
+table_cell_margins = OpenXml::Docx::Properties::TableCellMargins.new
+
+top_margin = OpenXml::Docx::Properties::TableCellMargin.new(:top)
+top_margin.type = :dxa
+top_margin.width = 0
+
+bottom_margin = OpenXml::Docx::Properties::TableCellMargin.new(:bottom)
+bottom_margin.type = :dxa
+bottom_margin.width = 0
+
+table_cell_margins << top_margin
+table_cell_margins << bottom_margin
+table_cell << table_cell_margins
+
+table_cell.v_align = :center
+
+paragraph = Paragraph.new
+table_cell << paragraph
+table_row << table_cell
+table << table_row
+document.document << table
+
+outline_paragraph = Paragraph.new
+outline_paragraph.spacing.after = 0
+outline_paragraph.spacing.line = 20
+outline_paragraph.spacing.line_rule = :exact
+
+outline_run = Run.new
+
+vml_container = VmlContainer.new
+
+round_rectangle = OpenXml::Vml::Elements::RoundedRectangle.new
+round_rectangle.arc_size = "6554f"
+round_rectangle.filled = :false
+round_rectangle.id = "AutoShape_x0020_31"
+round_rectangle.allow_in_cell = :false
+round_rectangle.optional_string = "_x0000_s1026"
+round_rectangle.stroke_color = "#bfbfbf"
+round_rectangle.stroke_weight = ".25pt"
+round_rectangle.print = :false
+style_string = "position:absolute;margin-left:13.55pt;margin-top:36.1pt;width:189.35pt;height:1in;z-index:251642880;visibility:visible;mso-wrap-style:square;mso-width-percent:0;mso-height-percent:0;mso-wrap-distance-left:9pt;mso-wrap-distance-top:0;mso-wrap-distance-right:9pt;mso-wrap-distance-bottom:0;mso-position-horizontal:absolute;mso-position-horizontal-relative:page;mso-position-vertical:absolute;mso-position-vertical-relative:page;mso-width-percent:0;mso-height-percent:0;mso-width-relative:page;mso-height-relative:page;v-text-anchor:top"
+round_rectangle.style = style_string
+
+vml_container << round_rectangle
+
+outline_run << vml_container
+
+outline_paragraph << outline_run
+
+document.document << outline_paragraph
+
+section_properties = SectionProperties.new
+
+page_size = OpenXml::Docx::Properties::PageSize.new
+page_size.height = 15840
+page_size.width = 12240
+section_properties << page_size
+
+page_margin = OpenXml::Docx::Properties::PageMargins.new
+page_margin.bottom = 600
+page_margin.footer = 0
+page_margin.gutter = 0
+page_margin.header = 0
+page_margin.left = 367
+page_margin.right = 446
+page_margin.top = 720
+
+section_properties << page_margin
+
+columns = OpenXml::Docx::Properties::Columns.new
+columns.space = 720
+
+section_properties << columns
+
+document.document << section_properties
+
+filename = "border_test.docx"
+system "rm -f ~/Desktop/#{filename}" # -f so that we don't have an error if the file doesn't exist
+document.save File.expand_path("~/Desktop/#{filename}")
+exec "open ~/Desktop/#{filename}"

data/examples/table

@@ -61,6 +61,34 @@ end
 
 document.document << table
 
+header = OpenXml::Docx::Parts::Header.new
+paragraph = Paragraph.new
+run = Run.new
+run << Text.new("This is some header text")
+paragraph << run
+header << paragraph
+
+header_id = document.add_header(header)
+
+footer = OpenXml::Docx::Parts::Footer.new
+paragraph = Paragraph.new
+run = Run.new
+run << Text.new("This is some footer text")
+paragraph << run
+footer << paragraph
+
+footer_id = document.add_footer(footer)
+
+section = OpenXml::Docx::Section.new
+section.header_reference.id = header_id
+section.header_reference.type = :default
+
+section.footer_reference.id = footer_id
+section.footer_reference.type = :default
+
+document.document << section
+
+
 filename = "rocx_test_table.docx"
 system "rm -f ~/Desktop/#{filename}" # -f so that we don't have an error if the file doesn't exist
 document.save File.expand_path("~/Desktop/#{filename}")

data/lib/openxml/docx.rb

@@ -3,16 +3,25 @@ module OpenXml
     REL_DOCUMENT = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument".freeze
     REL_STYLES = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles".freeze
     REL_SETTINGS = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/settings".freeze
+    REL_HEADER = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/header".freeze
+    REL_FOOTER = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/footer".freeze
+    REL_FONT_TABLE = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/fontTable".freeze
+    REL_FONT = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/font".freeze
 
     TYPE_STYLES = "application/vnd.openxmlformats-officedocument.wordprocessingml.styles+xml".freeze
     TYPE_SETTINGS = "application/vnd.openxmlformats-officedocument.wordprocessingml.settings+xml".freeze
+    TYPE_HEADER = "application/vnd.openxmlformats-officedocument.wordprocessingml.header+xml".freeze
+    TYPE_FOOTER = "application/vnd.openxmlformats-officedocument.wordprocessingml.footer+xml".freeze
+    TYPE_FONT_TABLE = "application/vnd.openxmlformats-officedocument.wordprocessingml.fontTable+xml".freeze
     TYPE_XML = "application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml".freeze
+    TYPE_OBSCURED_FONT = "application/vnd.openxmlformats-officedocument.obfuscatedFont".freeze
   end
 end
 
 require "openxml/docx/attribute_builder"
 require "openxml/docx/property_builder"
 require "openxml/docx/properties"
+require "openxml/docx/root_namespaces"
 require "openxml/docx/elements"
 require "openxml/docx/package"
 require "openxml/docx/parts"

data/lib/openxml/docx/attribute_builder.rb

@@ -203,24 +203,30 @@ module OpenXml
       end
 
       module ClassMethods
-        def attribute(name, expects: nil, displays_as: nil, namespace: nil)
+        def attribute(name, expects: nil, one_of: nil,  displays_as: nil, namespace: nil)
           bad_names = %w(tag name namespace properties_tag)
           raise ArgumentError if bad_names.member? name
 
           attr_reader name
 
           define_method "#{name}=" do |value|
-            send(expects, value)
+            valid_in?(value, one_of) unless one_of.nil?
+            send(expects, value) unless expects.nil?
             instance_variable_set "@#{name}", value
           end
 
           camelized_name = name.to_s.gsub(/_([a-z])/i) { $1.upcase }.to_sym
-          attributes[name] = [displays_as || camelized_name, namespace || :w]
+          attributes[name] = [displays_as || camelized_name, namespace || @attribute_namespace]
         end
 
         def attributes
           @attributes ||= {}
         end
+
+        def with_namespace(namespace, &block)
+          @attribute_namespace = namespace
+          instance_eval(&block)
+        end
       end
 
       def render?
@@ -237,7 +243,9 @@ module OpenXml
         attributes.each_with_object({}) do |(name, options), attrs|
           display, namespace = options
           value = send(name)
-          attrs["#{namespace}:#{display}"] = value if value
+          attr_name = "#{namespace}:#{display}"
+          attr_name = "#{display}" if namespace.nil?
+          attrs[attr_name] = value if value
         end
       end
 
@@ -276,6 +284,11 @@ module OpenXml
         raise ArgumentError, message if !value.is_a?(String) || value.length.zero?
       end
 
+      def percentage(value)
+        message = "Invalid #{name}: must be a percentage"
+        raise ArgumentError, message unless value.is_a?(String) && value =~ /-?[0-9]+(\.[0-9]+)?%/ # Regex supplied in sec. 22.9.2.9 of Office Open XML docs
+      end
+
       def on_or_off(value)
         valid_in? value, [:on, :off]
       end

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

@@ -3,26 +3,11 @@ module OpenXml
     module Elements
       class AbsolutePositionTab < Element
         tag :ptab
-        attribute :alignment, expects: :valid_ptab_alignment
-        attribute :leader, expects: :valid_ptab_leader
-        attribute :relativeTo, expects: :valid_ptab_relative_to
 
-        VALID_PTAB_ALIGNMENTS = %i(center left right)
-        VALID_PTAB_LEADERS = %i(dot hyphen middleDot none underscore)
-        VALID_PTAB_RELATIVE_TOS = %i(indent margin)
-
-      private
-
-        def valid_ptab_alignment(value)
-          valid_in? value, VALID_PTAB_ALIGNMENTS
-        end
-
-        def valid_ptab_leader(value)
-          valid_in? value, VALID_PTAB_LEADERS
-        end
-
-        def valid_ptab_relative_to(value)
-          valid_in? value, VALID_PTAB_RELATIVE_TOS
+        with_namespace :w do
+          attribute :alignment, one_of: %i(center left right)
+          attribute :leader, one_of: %i(dot hyphen middleDot none underscore)
+          attribute :relativeTo, one_of: %i(indent margin)
         end
 
       end

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

@@ -3,16 +3,7 @@ module OpenXml
     module Elements
       class BidiEmbed < Container
         tag :dir
-        attribute :direction, expects: :valid_direction, displays_as: :val
-
-        VALID_DIRECTIONS = %i(rtl ltr)
-
-      private
-
-        def valid_direction(value)
-          valid_in? value, VALID_DIRECTIONS
-        end
-
+        attribute :direction, one_of: %i(rtl ltr), displays_as: :val, namespace: :w
       end
     end
   end

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

@@ -3,15 +3,7 @@ module OpenXml
     module Elements
       class BidiOverride < Container
         tag :bdo
-        attribute :direction, expects: :valid_direction, displays_as: :val
-
-        VALID_DIRECTIONS = %i(rtl ltr)
-
-      private
-
-        def valid_direction(value)
-          valid_in? value, VALID_DIRECTIONS
-        end
+        attribute :direction, one_of: %i(rtl ltr), displays_as: :val, namespace: :w
 
       end
     end

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

@@ -4,20 +4,9 @@ module OpenXml
       class Break < Element
         tag :br
 
-        attribute :clear, expects: :valid_clear
-        attribute :type, expects: :valid_break_type
-
-        VALID_CLEARS = %i(all left none right)
-        VALID_BREAK_TYPES = %i(column page textWrapping)
-
-      private
-
-        def valid_clear(value)
-          valid_in? value, VALID_CLEARS
-        end
-
-        def valid_break_type(value)
-          valid_in? value, VALID_BREAK_TYPES
+        with_namespace :w do
+          attribute :clear, one_of: %i(all left none right)
+          attribute :type, one_of: %i(column page textWrapping)
         end
 
       end

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

@@ -3,8 +3,11 @@ module OpenXml
     module Elements
       class Control < Element
         attribute :id, expects: :string, namespace: :r
-        attribute :unique_name, expects: :string, displays_as: :name
-        attribute :shape_id, expects: :string, displays_as: :shapeid
+
+        with_namespace :w do
+          attribute :unique_name, expects: :string, displays_as: :name
+          attribute :shape_id, expects: :string, displays_as: :shapeid
+        end
 
       end
     end

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

@@ -3,7 +3,7 @@ module OpenXml
     module Elements
       class DeletedText < Text
         tag :del
-        attribute :space, expects: :valid_space_preserve, namespace: :xml
+        attribute :space, one_of: [:preserve, nil], namespace: :xml
       end
     end
   end

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

@@ -0,0 +1,9 @@
+module OpenXml
+  module Docx
+    module Elements
+      class Drawing < Element
+        tag :drawing
+      end
+    end
+  end
+end

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

@@ -6,6 +6,7 @@ module OpenXml
 
         class << self
           attr_reader :property_name
+          attr_reader :namespace
 
           def tag(*args)
             @tag = args.first if args.any?
@@ -37,7 +38,7 @@ module OpenXml
         end
 
         def to_xml(xml)
-          xml["w"].public_send(tag, xml_attributes)
+          xml[namespace].public_send(tag, xml_attributes)
         end
 
       private

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

@@ -0,0 +1,25 @@
+module OpenXml
+  module Docx
+    module Elements
+      class EmbedBold < Element
+        namespace :w
+
+        with_namespace :w do
+          attribute :font_key, expects: :bracketed_guid, displays_as: :fontKey
+          attribute :subsetted, expects: :true_or_false
+        end
+
+        attribute :relationship_id, expects: :string, displays_as: :id, namespace: :r
+
+
+      private
+
+        def bracketed_guid(value)
+          guid_regex = /\{[0-9A-F]{8}\-[0-9A-F]{4}\-[0-9A-F]{4}\-[0-9A-F]{4}\-[0-9A-F]{12}\}/ # Regex taken from spec section 22.9.2.4
+          raise ArgumentError, "Not a validly-formatted GUID" unless value =~ guid_regex
+        end
+
+      end
+    end
+  end
+end