openxml-docx 0.10.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 721596bd0a99e7649d104985afa53b7152101fa6
-  data.tar.gz: e956ff4f80b2ce46f3022e5a05f92bb99e7057ef
+  metadata.gz: 281ebe5865109648134cd7d0e38f3dece19e3bb1
+  data.tar.gz: 5198b7f285a17344137d32f5f53044bd44f63e87
 SHA512:
-  metadata.gz: bbfecbf3a5aa07b90d1909c0642926dc025cafd08866f75b283768c3b7e0943b88a29737bcd92a0e4de90e29a1011f35d9fdc8514480157f1238d67c8b91caf5
-  data.tar.gz: a0aeb4b5b1032e62f3531498e9d3ffe4e27ef4e7834d41e80917fcb4edfa57c0eabbd4cfed81688245f8f30476a739f9da76d4bae7a38f7e9ea8f7ec78d0f8bc
+  metadata.gz: e405e98f203bbd647a9e29a164da5c4fee1f23e64092f56e9aefd73f4f7b5fcd5d29dbd9cd3292394b571e61216b2d0a23071a0a5d9e11174e02d3fe78f85f71
+  data.tar.gz: 41d7848b012173dac7a9b62819586d022d02c7bc6b2a36810c7e60c555f2fed5b18c6feb89ed205ca3ebf3e52bf95517181c64af23a5ecfac8d3cd26d524de6c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openxml-docx (0.10.0)
+    openxml-docx (0.10.1)
       nokogiri
       openxml-package (>= 0.2.2)
 
@@ -14,7 +14,7 @@ GEM
     json (1.8.3)
     method_source (0.8.2)
     mini_portile2 (2.0.0)
-    nokogiri (1.6.7)
+    nokogiri (1.6.7.1)
       mini_portile2 (~> 2.0.0.rc2)
     openxml-package (0.2.2)
       nokogiri

data/examples/drawing-ml

@@ -11,7 +11,7 @@ document = OpenXml::Docx::Package.new
 table = Table.new
 table.table_width.type = :auto
 table.table_width.width = 0
-table.table_layout = :fixed
+table.table_layout.type = :fixed
 
 table_cell_margins = OpenXml::Docx::Properties::TableCellMargins.new
 start_margin = OpenXml::Docx::Properties::TableCellMargin.new(:start)

data/examples/image-embedding

@@ -0,0 +1,141 @@
+#!/usr/bin/env ruby
+
+$:.push Dir.pwd + "/lib"
+require "pry"
+require "ox"
+require "openxml/docx"
+require "openxml/drawingml"
+
+package = OpenXml::Docx::Package.new
+
+include OpenXml::Docx::Elements
+include OpenXml::DrawingML::Elements
+
+text = Text.new("Some text that I want to include in my new OOXML document")
+
+run = Run.new
+run << text
+paragraph = Paragraph.new
+paragraph << run
+
+package.document << paragraph
+
+image_rid = package.embed_image(path: File.join(File.dirname(__FILE__), "ochanomizu.jpg"))
+
+paragraph = Paragraph.new
+run = Run.new
+
+# This is the overall container for the drawing elements
+drawing = Drawing.new
+
+# This is the anchor that provides positioning information in Word
+anchor = WordProcessingDrawingAnchor.new
+anchor.allow_overlap = true
+anchor.behind_document = false
+anchor.layout_in_cell = true
+anchor.locked = false
+anchor.z_index = 1000
+anchor.simple_position = false
+anchor.distance_from_bottom = 0
+anchor.distance_from_top = 0
+anchor.distance_from_left = 0
+anchor.distance_from_right = 0
+
+# These elements are required to be children of anchor and supply the actual positioning information
+simple_pos = WordProcessingDrawingSimplePosition.new
+simple_pos.x = 0
+simple_pos.y = 0
+anchor << simple_pos
+position_h = WordProcessingDrawingPositionH.new
+position_h.relative_from = :column
+position_offset = WordProcessingDrawingPositionOffset.new
+position_offset.value = "0"
+position_h << position_offset
+anchor << position_h
+position_v = WordProcessingDrawingPositionV.new
+position_v.relative_from = :paragraph
+position_offset = WordProcessingDrawingPositionOffset.new
+position_offset.value = "0"
+position_v << position_offset
+anchor << position_v
+
+# Extent is the size of the Object
+extent = WordProcessingDrawingExtent.new
+extent.extent_length = 599 * 20 # Convert pixels to EMU?
+extent.extent_width = 393 * 20
+anchor << extent
+
+# One of the wrap properties is required
+anchor << WordProcessingDrawingWrapNone.new
+
+# Object (non-visual) properties are also required
+doc_pr = WordProcessingDrawingObjectNvProperties.new
+doc_pr.description = "ochanomizu.jpg"
+doc_pr.object_name = "Ochanomizu but not from Tetsuwan Atomu"
+doc_pr.id = 1
+anchor << doc_pr
+
+# This is the actual graphics object
+graphic = Graphic.new
+graphic_data = GraphicData.new
+graphic_data.uri = "http://schemas.openxmlformats.org/drawingml/2006/picture"
+pic_container = Picture.new
+
+# Must also define the Picture's non-visual Properties
+pic_nv_properties = NonVisualPictureProperties.new
+nv_properties = NonVisualDrawingProperties.new
+nv_properties.id = 0
+nv_properties.picture_name = "Ochanomizu but not from Tetsuwan Atomu"
+nv_properties.description = "ochanomizu.jpg"
+pic_nv_properties << nv_properties
+drawing_properties = NonVisualPictureDrawingProperties.new
+picture_locks = PictureLocks.new
+picture_locks.disallow_aspect_ratio_changes = true
+picture_locks.disallow_arrowhead_changes = true
+drawing_properties << picture_locks
+pic_nv_properties << drawing_properties
+pic_container << pic_nv_properties
+
+# Blip Fill defines the picture that will fill the object's shape
+blip_fill = BlipFill.new
+pic_ref = Blip.new
+pic_ref.embed = image_rid
+stretch = Stretch.new
+fill_rect = FillRectangle.new
+stretch << fill_rect
+blip_fill << pic_ref
+blip_fill << stretch
+blip_fill << SourceRectangle.new
+pic_container << blip_fill
+
+# Must also define the picture's shape properties
+shape_properties = PictureShapeProperties.new
+shape_properties.black_and_white_mode = :auto
+preset_geometry = PresetGeometry.new
+preset_geometry.preset = :rect
+shape_properties << preset_geometry
+transform = TransformEffect.new
+offset = Offset.new
+offset.x = 0
+offset.y = 0
+transform << offset
+extent = Extents.new
+extent.extent_length = 599 * 20
+extent.extent_width = 393 * 20
+transform << extent
+shape_properties << transform
+pic_container << shape_properties
+
+graphic_data << pic_container
+graphic << graphic_data
+
+anchor << graphic
+drawing << anchor
+run << drawing
+paragraph << run
+package.document << paragraph
+
+filename = "image_embedding_test.docx"
+system "rm -f ~/Desktop/#{filename}" # -f so that we don't have an error if the file doesn't exist
+package.save File.expand_path("~/Desktop/#{filename}")
+exec "open ~/Desktop/#{filename}"

data/lib/openxml/docx.rb

@@ -7,6 +7,7 @@ module OpenXml
     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
+    REL_IMAGE = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/image".freeze
 
     TYPE_STYLES = "application/vnd.openxmlformats-officedocument.wordprocessingml.styles+xml".freeze
     TYPE_SETTINGS = "application/vnd.openxmlformats-officedocument.wordprocessingml.settings+xml".freeze
@@ -15,6 +16,13 @@ module OpenXml
     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
+    TYPE_IMAGE = {
+      jpeg: "image/jpeg".freeze,
+      png: "image/png".freeze,
+      gif: "image/gif".freeze,
+      bmp: "image/bmp".freeze,
+      tiff: "image/tiff".freeze
+    }
   end
 end
 

data/lib/openxml/docx/attribute_builder.rb

@@ -245,7 +245,7 @@ module OpenXml
           value = send(name)
           attr_name = "#{namespace}:#{display}"
           attr_name = "#{display}" if namespace.nil?
-          attrs[attr_name] = value if value
+          attrs[attr_name] = value unless value.nil?
         end
       end
 
@@ -269,6 +269,16 @@ module OpenXml
         raise ArgumentError, message unless value =~ /[0-9A-F]{4}/
       end
 
+      def long_hex_number(value)
+        message = "Invalid #{name}: must be an eight-digit hex number, e.g., FFAC0013"
+        raise ArgumentError, message unless value =~ /^[0-9A-F]{8}$/
+      end
+
+      def hex_string(value)
+        message = "Invalid #{name}: must be a string of hexadecimal numbers, e.g. FFA23C6E"
+        raise ArgumentError, message unless value =~ /^[0-9A-F]+$/
+      end
+
       def integer(value)
         message = "Invalid #{name}: must be an integer"
         raise ArgumentError, message unless value.is_a?(Integer)

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

@@ -0,0 +1,12 @@
+module OpenXml
+  module Docx
+    module Elements
+      class BookFoldPrinting < Element
+        tag :bookFoldPrinting
+
+        attribute :value, expects: :true_or_false, displays_as: :val, namespace: :w
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+module OpenXml
+  module Docx
+    module Elements
+      class BookFoldPrintingSheets < Element
+        tag :bookFoldPrintingSheets
+
+        attribute :value, expects: :positive_integer, displays_as: :val, namespace: :w
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+module OpenXml
+  module Docx
+    module Elements
+      class BookFoldReversePrinting < Element
+        tag :bookFoldRevPrinting
+
+        attribute :value, expects: :true_or_false, displays_as: :val, namespace: :w
+
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,14 @@
+module OpenXml
+  module Docx
+    module Elements
+      class EmbedSystemFonts < Element
+        namespace :w
+
+        with_namespace :w do
+          attribute :value, expects: :true_or_false, displays_as: :val
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module OpenXml
+  module Docx
+    module Elements
+      class EmbedTrueTypeFonts < Element
+        namespace :w
+
+        with_namespace :w do
+          attribute :value, expects: :true_or_false, displays_as: :val
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module OpenXml
+  module Docx
+    module Elements
+      class FontAlternateName < Element
+        namespace :w
+        tag :altName
+
+        with_namespace :w do
+          attribute :value, expects: :string, displays_as: :val
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module OpenXml
+  module Docx
+    module Elements
+      class FontCharacterSet < Element
+        namespace :w
+        tag :charset
+
+        with_namespace :w do
+          attribute :character_set, expects: :string, displays_as: :characterSet
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module OpenXml
+  module Docx
+    module Elements
+      class FontPanoseOne < Element
+        namespace :w
+        tag :panose1
+
+        with_namespace :w do
+          attribute :value, expects: :hex_string, displays_as: :val
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module OpenXml
+  module Docx
+    module Elements
+      class FontPitch < Element
+        namespace :w
+        tag :pitch
+
+        with_namespace :w do
+          attribute :value, one_of: %i(default fixed variable), displays_as: :val
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+module OpenXml
+  module Docx
+    module Elements
+      class FontSig < Element
+        namespace :w
+        tag :sig
+
+        with_namespace :w do
+          attribute :csb0, expects: :long_hex_number
+          attribute :csb1, expects: :long_hex_number
+          attribute :usb0, expects: :long_hex_number
+          attribute :usb1, expects: :long_hex_number
+          attribute :usb2, expects: :long_hex_number
+          attribute :usb3, expects: :long_hex_number
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module OpenXml
+  module Docx
+    module Elements
+      class SaveSubsetFonts < Element
+        namespace :w
+
+        with_namespace :w do
+          attribute :value, expects: :true_or_false, displays_as: :val
+        end
+
+      end
+    end
+  end
+end

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

@@ -5,17 +5,19 @@ module OpenXml
         tag :anchor
         namespace :wp
 
-        attribute :allowOverlap, expects: :true_or_false
-        attribute :behindDoc, expects: :true_or_false
-        attribute :distB, expects: :positive_integer
-        attribute :distL, expects: :positive_integer
-        attribute :distR, expects: :positive_integer
-        attribute :distT, expects: :positive_integer
-        attribute :hidden, expects: :true_or_false
-        attribute :layoutInCell, expects: :true_or_false
-        attribute :locked, expects: :true_or_false
-        attribute :relativeHeight, expects: :positive_integer
-        attribute :simplePos, expects: :true_or_false
+        attribute :allow_overlap, expects: :true_or_false, displays_as: :allowOverlap         # Required
+        attribute :behind_document, expects: :true_or_false, displays_as: :behindDoc          # Required
+        attribute :distance_from_bottom, expects: :positive_integer, displays_as: :distB      # Optional
+        attribute :distance_from_left, expects: :positive_integer, displays_as: :distL        # Optional
+        attribute :distance_from_right, expects: :positive_integer, displays_as: :distR       # Optional
+        attribute :distance_from_top, expects: :positive_integer, displays_as: :distT         # Optional
+        attribute :hidden, expects: :true_or_false                                            # Optional
+        attribute :layout_in_cell, expects: :true_or_false, displays_as: :layoutInCell        # Required
+        attribute :locked, expects: :true_or_false                                            # Required
+        attribute :z_index, expects: :positive_integer, displays_as: :relativeHeight          # Required
+        attribute :simple_position, expects: :true_or_false, displays_as: :simplePos          # Optional
+
+        # Children elements required by spec: <docPr>, <a:graphic>, <wp:simplePos>, <wp:positionH>, <wp:positionV>, <wp:extent>, and one of the wp: wrap type tags
 
       end
     end