openxml-docx 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9cc4cd3b3d4cbf278bef9e5e12ef57932b2a099c
-  data.tar.gz: 2abcccf45ba8f30f4db9c6a5807eef2e3dc226ae
+  metadata.gz: 1972ebd1b0c107bf2b90517f68e43451dd2ce03e
+  data.tar.gz: 98dccd8c85eee5358beb36727ec4a9d73f2c0631
 SHA512:
-  metadata.gz: 50df25f5a8513f94f57503816ab68a699c07bff69741527dd7c8ae25137393803b17bfe11ac2c82eee93a6ff3903356ec1c867453468df5bff084ca86a271ec0
-  data.tar.gz: 354a007bebb94ed5e42fc6788f992b1b54131eeca1cfb64ac034a0b3cf15ed70f76a86c1fa4c42386116c35b217c785f0b76839130cd04235ee8545e5ab74e13
+  metadata.gz: 932d7911afa2eddb1611f2990a23fe4a6e5729f156d93a45a7c255e5e90eaabb5900d3c619b236320d838fe523676f959170f35b43b6c1b2ac894a12e2819a2f
+  data.tar.gz: 32f62f244add36189be452dd40eb7a5e5521e17139d22fd27562cce63149ae61df95e98dd3fd661d6adc601e0462efef10e8700059946a3eeb8e0a8373205201

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openxml-docx (0.8.0)
+    openxml-docx (0.9.0)
       nokogiri
       openxml-package (>= 0.2.1)
 

data/{example → examples/base}

@@ -17,7 +17,7 @@ paragraph << run
 
 document.document << paragraph
 
-filename = "gemtest1.docx"
+filename = "rocx_test_base.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

@@ -0,0 +1,68 @@
+#!/usr/bin/env ruby
+
+# require "rails" # workaround: openxml-package uses `extract_options!`
+$:.push Dir.pwd + "/lib"
+require "ox"
+require "openxml/docx"
+
+
+def default_table_style
+  style = OpenXml::Docx::Style.new(:table)
+  style.id = "TableGrid"
+
+  table_grid_tags.each do |tag_name|
+    tag = OpenXml::Docx::Properties::TableBorder.new(tag_name, :single)
+    table_border_styles = {width: 4, space: 0, color: "000000"}
+    table_border_styles.each {|key, val| tag.send("#{key}=", val) }
+    style.table.table_borders <<  tag
+  end
+
+  table_cell_margin_tags.each do |tag_name|
+    tag = OpenXml::Docx::Properties::TableCellMargin.new(tag_name)
+    tag.type = :dxa
+    tag.width = %i(start end).include?(tag_name) ? 108 : 0
+    style.table.table_cell_margins << tag
+  end
+
+  style
+end
+
+def table_grid_tags
+  %i(start end top bottom insideH insideV)
+end
+
+def table_cell_margin_tags
+  %i(top start bottom end)
+end
+
+
+ROWS = 4
+CELLS = 4
+
+document = OpenXml::Docx::Package.new
+document.styles << default_table_style
+
+include OpenXml::Docx::Elements
+
+table = Table.new
+table.table_style = "TableGrid"
+
+ROWS.times do
+  row = TableRow.new
+
+  CELLS.times do
+    cell = TableCell.new
+    paragraph = Paragraph.new
+    cell << paragraph
+    row << cell
+  end
+  table << row
+end
+
+document.document << table
+
+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}")
+exec "open ~/Desktop/#{filename}"
+

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

@@ -0,0 +1,12 @@
+module OpenXml
+  module Docx
+    module Elements
+      class GridColumn < Element
+        tag :gridColumn
+
+        attribute :w, expects: :integer
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+module OpenXml
+  module Docx
+    module Elements
+      class Table < Container
+        tag :tbl
+
+        value_property :bidi_visual, as: :bidi
+        value_property :cant_split
+        value_property :div_id
+        value_property :alignment
+        value_property :table_caption
+        value_property :table_description
+        value_property :table_layout
+        value_property :table_overlap
+        value_property :table_style
+
+        property :conditional_formatting
+        property :shading
+        property :table_borders
+        property :table_cell_margins
+        property :table_cell_spacing
+        property :table_indent
+        property :table_look
+        property :table_p_pr
+        property :table_width
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+module OpenXml
+  module Docx
+    module Elements
+      class TableCell < Container
+        tag :tc
+
+        attribute :id
+
+        value_property :div_id
+        value_property :grid_span
+        value_property :hide_mark
+        value_property :no_wrap
+        value_property :table_cell_fit_text
+        value_property :text_direction
+
+        property :conditional_formatting
+        property :headers
+        property :shading
+        property :table_cell_borders
+        property :table_cell_cell_margin
+        property :table_cell_width
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+module OpenXml
+  module Docx
+    module Elements
+      class TableGrid < Container
+        tag :tblGrid
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+module OpenXml
+  module Docx
+    module Elements
+      class TableRow < Container
+        tag :tr
+
+        attribute :rsidDel, expects: :valid_long_hex
+        attribute :rsidR, expects: :valid_long_hex
+        attribute :rsidRPr, expects: :valid_long_hex
+        attribute :risdTr, expects: :valid_long_hex
+
+        value_property :cant_split
+        value_property :div_id
+        value_property :grid_after
+        value_property :grid_before
+        value_property :hidden
+        value_property :alignment
+        value_property :table_header
+        value_property :v_align
+
+        property :conditional_formatting
+        property :table_cell_spacing
+        property :tr_height
+        property :w_after
+        property :w_before
+
+      private
+
+        def valid_long_hex(value)
+          value =~ /^[0-9a-f]+$/i
+        end
+
+      end
+    end
+  end
+end

data/lib/openxml/docx/package.rb

@@ -23,6 +23,9 @@ module OpenXml
         @styles = OpenXml::Docx::Parts::Styles.new
         @document = OpenXml::Docx::Parts::Document.new
 
+        doc_rels.add_relationship REL_STYLES, "styles.xml"
+        doc_rels.add_relationship REL_SETTINGS, "settings.xml"
+
         add_part "word/_rels/document.xml.rels", doc_rels
         add_part "word/document.xml", document
         add_part "word/settings.xml", settings

data/lib/openxml/docx/properties.rb

@@ -11,9 +11,11 @@ require "openxml/docx/properties/value_property"
 require "openxml/docx/properties/boolean_property"
 require "openxml/docx/properties/integer_property"
 require "openxml/docx/properties/positive_integer_property"
+require "openxml/docx/properties/string_property"
 require "openxml/docx/properties/on_off_property"
 require "openxml/docx/properties/toggle_property"
 require "openxml/docx/properties/string_property"
+require "openxml/docx/properties/width_property"
 require "openxml/docx/properties/container_property"
 require "openxml/docx/properties/style"
 Dir.glob("#{File.join(File.dirname(__FILE__), "properties", "*.rb")}").each do |file|

data/lib/openxml/docx/properties/base_property.rb

@@ -6,6 +6,12 @@ module OpenXml
 
         class << self
           attr_reader :property_name
+          attr_reader :allowed_tags
+
+          def tag_is_one_of(tags)
+            attr_accessor :tag
+            @allowed_tags = tags
+          end
 
           def tag(*args)
             @tag = args.first if args.any?
@@ -18,6 +24,14 @@ module OpenXml
           end
         end
 
+        def initialize(tag=nil, *args)
+          return unless self.class.allowed_tags
+          unless self.class.allowed_tags.include?(tag)
+            raise ArgumentError, "Invalid tag name for #{name}: #{tag.inspect}. It should be one of #{self.class.allowed_tags.join(", ")}."
+          end
+          @tag = tag
+        end
+
         def render?
           !value.nil?
         end

data/lib/openxml/docx/properties/cant_split.rb

@@ -0,0 +1,8 @@
+module OpenXml
+  module Docx
+    module Properties
+      class CantSplit < ToggleProperty
+      end
+    end
+  end
+end

data/lib/openxml/docx/properties/columns.rb

@@ -1,3 +1,5 @@
+require "openxml/docx/properties/column"
+
 module OpenXml
   module Docx
     module Properties

data/lib/openxml/docx/properties/grid_after.rb

@@ -0,0 +1,8 @@
+module OpenXml
+  module Docx
+    module Properties
+      class GridAfter < IntegerProperty
+      end
+    end
+  end
+end

data/lib/openxml/docx/properties/grid_before.rb

@@ -0,0 +1,8 @@
+module OpenXml
+  module Docx
+    module Properties
+      class GridBefore < IntegerProperty
+      end
+    end
+  end
+end

data/lib/openxml/docx/properties/grid_span.rb

@@ -0,0 +1,8 @@
+module OpenXml
+  module Docx
+    module Properties
+      class GridSpan < PositiveIntegerProperty
+      end
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+module OpenXml
+  module Docx
+    module Properties
+      class Header < StringProperty
+      end
+    end
+  end
+end

data/lib/openxml/docx/properties/headers.rb

@@ -0,0 +1,12 @@
+require "openxml/docx/properties/header"
+
+module OpenXml
+  module Docx
+    module Properties
+      class Headers < ContainerProperty
+        child_class :header
+
+      end
+    end
+  end
+end

data/lib/openxml/docx/properties/hidden.rb

@@ -0,0 +1,8 @@
+module OpenXml
+  module Docx
+    module Properties
+      class Hidden < ToggleProperty
+      end
+    end
+  end
+end

data/lib/openxml/docx/properties/hide_mark.rb

@@ -0,0 +1,8 @@
+module OpenXml
+  module Docx
+    module Properties
+      class HideMark < ToggleProperty
+      end
+    end
+  end
+end

data/lib/openxml/docx/properties/no_wrap.rb

@@ -0,0 +1,8 @@
+module OpenXml
+  module Docx
+    module Properties
+      class NoWrap < ToggleProperty
+      end
+    end
+  end
+end

data/lib/openxml/docx/properties/table_border.rb

@@ -0,0 +1,25 @@
+module OpenXml
+  module Docx
+    module Properties
+      class TableBorder < ComplexProperty
+        tag_is_one_of %i(top start bottom end insideH insideV)
+
+        attribute :color, expects: :hex_color
+        attribute :frame, expects: :true_or_false
+        attribute :shadow, expects: :true_or_false
+        attribute :space, expects: :positive_integer
+        attribute :theme_color, expects: :valid_theme_color
+        attribute :theme_shade, expects: :hex_digit
+        attribute :theme_tint, expects: :hex_digit
+        attribute :value, expects: :valid_type, displays_as: :val
+        attribute :width, expects: :positive_integer, displays_as: :sz
+
+        def initialize(tag, value)
+          super tag
+          @value = value
+        end
+
+      end
+    end
+  end
+end

data/lib/openxml/docx/properties/table_borders.rb

@@ -0,0 +1,13 @@
+require "openxml/docx/properties/table_border"
+
+module OpenXml
+  module Docx
+    module Properties
+      class TableBorders < ContainerProperty
+        tag :tblBorders
+        child_class :table_border
+
+      end
+    end
+  end
+end

data/lib/openxml/docx/properties/table_caption.rb

@@ -0,0 +1,10 @@
+module OpenXml
+  module Docx
+    module Properties
+      class TableCaption < StringProperty
+        tag :tblCaption
+
+      end
+    end
+  end
+end

data/lib/openxml/docx/properties/table_cell_border.rb

@@ -0,0 +1,25 @@
+module OpenXml
+  module Docx
+    module Properties
+      class TableCellBorder < ComplexProperty
+        tag_is_one_of %i(top start bottom end insideH insideV tl2br tr2bl)
+
+        attribute :color, expects: :hex_color
+        attribute :frame, expects: :true_or_false
+        attribute :shadow, expects: :true_or_false
+        attribute :space, expects: :positive_integer
+        attribute :theme_color, expects: :valid_theme_color
+        attribute :theme_shade, expects: :hex_digit
+        attribute :theme_tint, expects: :hex_digit
+        attribute :value, expects: :valid_type, displays_as: :val
+        attribute :width, expects: :positive_integer, displays_as: :sz
+
+        def initialize(tag, value)
+          super tag
+          self.value = value
+        end
+
+      end
+    end
+  end
+end