openxml-docx 0.8.0.beta1

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

@@ -0,0 +1,17 @@
+module OpenXml
+  module Docx
+    module Properties
+      class OnOffProperty < ValueProperty
+
+        def ok_values
+          [nil, :on, :off]
+        end
+
+        def to_xml(xml)
+          xml["w"].public_send(tag, "w:val" => value) if value
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+module OpenXml
+  module Docx
+    module Properties
+      class Outline < BooleanProperty
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+module OpenXml
+  module Docx
+    module Properties
+      class OutlineLevel < PositiveIntegerProperty
+        tag :outlineLvl
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+module OpenXml
+  module Docx
+    module Properties
+      class OverflowPunctuation < BooleanProperty
+        tag :overflowPunct
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+module OpenXml
+  module Docx
+    module Properties
+      class PageBorders < ComplexProperty
+        attr_reader :left, :right, :top, :bottom
+
+        tag :pgBorders
+        attribute :display, expects: :valid_display
+        attribute :offset_from, expects: :valid_offset
+        attribute :z_order, expects: :valid_z_order
+
+        def initialize
+          @left = new_border :left
+          @right = new_border :right
+          @top = new_border :top
+          @bottom = new_border :bottom
+        end
+
+        def render?
+          renderable_borders.any?
+        end
+
+        def to_xml(xml)
+          return unless render?
+          xml["w"].public_send(tag, xml_attributes) { render_borders_xml(xml) }
+        end
+
+        VALID_DISPLAYS = %i(allPages firstPage notFirstPage)
+        VALID_OFFSETS = %i(page text)
+        VALID_Z_ORDERS = %i(front back)
+
+      private
+
+        def render_borders_xml(xml)
+          renderable_borders.each { |border| border.to_xml(xml) }
+        end
+
+        def renderable_borders
+          [@left, @right, @top, @bottom].select(&:render?)
+        end
+
+        def new_border(direction)
+          OpenXml::Docx::Properties::Border.new direction
+        end
+
+        def valid_display(value)
+          valid_in? value, VALID_DISPLAYS
+        end
+
+        def valid_offset(value)
+          valid_in? value, VALID_OFFSETS
+        end
+
+        def valid_z_order(value)
+          valid_in? value, VALID_Z_ORDERS
+        end
+
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,17 @@
+module OpenXml
+  module Docx
+    module Properties
+      class PageMargins < ComplexProperty
+        tag :pgMar
+
+        attribute :bottom, expects: :integer
+        attribute :footer, expects: :positive_integer
+        attribute :gutter, expects: :positive_integer
+        attribute :header, expects: :positive_integer
+        attribute :left, expects: :positive_integer
+        attribute :right, expects: :positive_integer
+        attribute :top, expects: :integer
+      end
+    end
+  end
+end

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

@@ -0,0 +1,89 @@
+module OpenXml
+  module Docx
+    module Properties
+      class PageNumbering < ComplexProperty
+        tag :pgNumType
+
+        attribute :chapter_separator, expects: :valid_chapter_separator, displays_as: :chapSep
+        attribute :chapter_style, expects: :integer, displays_as: :chapStyle
+        attribute :format, expects: :valid_page_number_format, displays_as: :fmt
+        attribute :start, expects: :integer
+
+        VALID_CHAPTER_SEPARATORS = %i(colon emDash enDash hyphen period)
+        VALID_PAGE_NUMBER_FORMATS = %i(aiueo
+                                       aiueoFullWidth
+                                       arabicAbjad
+                                       arabicAlpha
+                                       bahtText
+                                       bullet
+                                       cardinalText
+                                       chicago
+                                       chineseCounting
+                                       chineseCountingThousand
+                                       chineseLegalSimplified
+                                       chosung
+                                       custom
+                                       decimal
+                                       decimalEnclosedCircle
+                                       decimalEnclosedCircleChinese
+                                       decimalEnclosedFullstop
+                                       decimalEnclosedParen
+                                       decimalFullWidth
+                                       decimalHalfWidth
+                                       decimalZero
+                                       dollarText
+                                       ganada
+                                       hebrew1
+                                       hebrew2
+                                       hex
+                                       hindiConsonants
+                                       hindiCounting
+                                       hindiNumbers
+                                       hindiVowels
+                                       ideographDigital
+                                       ideographEnclosedCircle
+                                       taiwaneseDigital
+                                       ideographLegalTraditional
+                                       ideographTraditional
+                                       ideographZodiac
+                                       ideographZodiacTraditional
+                                       iroha
+                                       irohaFullWidth
+                                       japaneseCounting
+                                       japaneseDigitalTenThousand
+                                       japaneseLegal
+                                       koreanCounting
+                                       koreanDigital
+                                       koreanDigital2
+                                       koreanLegal
+                                       lowerLetter
+                                       lowerRoman
+                                       none
+                                       numberInDash
+                                       ordinal
+                                       ordinalText
+                                       russianLower
+                                       russianUpper
+                                       taiwaneseCounting
+                                       taiwaneseCountingThousand
+                                       thaiCounting
+                                       thaiLetters
+                                       thaiNumbers
+                                       upperLetter
+                                       upperRoman
+                                       vietnameseCounting)
+
+      private
+
+        def valid_chapter_separator(value)
+          valid_in? value, VALID_CHAPTER_SEPARATORS
+        end
+
+        def valid_page_number_format(value)
+          valid_in? value, VALID_PAGE_NUMBER_FORMATS
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module OpenXml
+  module Docx
+    module Properties
+      class PageSize < ComplexProperty
+        tag :pgSz
+
+        attribute :code, expects: :integer
+        attribute :height, expects: :positive_integer, displays_as: :h
+        attribute :orientation, expects: :valid_orientation, displays_as: :orient
+        attribute :width, expects: :positive_integer, displays_as: :w
+
+        VALID_PAGE_ORIENTATIONS = %i(portrait landscape)
+
+      private
+
+        def valid_orientation(value)
+          valid_in? value, VALID_PAGE_ORIENTATIONS
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+module OpenXml
+  module Docx
+    module Properties
+      class ParagraphBorders < ComplexProperty
+        attr_reader :left, :right, :top, :bottom, :between, :bar
+
+        def initialize
+          @left = new_border :left
+          @right = new_border :right
+          @top = new_border :top
+          @bottom = new_border :bottom
+          @between = new_border :between
+          @bar = new_border :bar
+        end
+
+        tag :pBdr
+        name "borders"
+
+        def render?
+          renderable_borders.any?
+        end
+
+        def to_xml(xml)
+          return unless render?
+          xml["w"].public_send(tag) { render_borders_xml(xml) }
+        end
+
+      private
+
+        def render_borders_xml(xml)
+          renderable_borders.each { |border| border.to_xml(xml) }
+        end
+
+        def renderable_borders
+          [@left, @right, @top, @bottom, @between, @bar].select(&:render?)
+        end
+
+        def new_border(direction)
+          OpenXml::Docx::Properties::Border.new direction
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+module OpenXml
+  module Docx
+    module Properties
+      class ParagraphStyle < Style
+        tag :pStyle
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module OpenXml
+  module Docx
+    module Properties
+      class ParentStyle < ValueProperty
+        tag :basedOn
+
+        def valid?
+          value.is_a?(String) && value.length > 0
+        end
+
+        def invalid_message
+          "#{name} must be a string that is not empty"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+module OpenXml
+  module Docx
+    module Properties
+      class Personal < BooleanProperty
+      end
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+module OpenXml
+  module Docx
+    module Properties
+      class PersonalCompose < BooleanProperty
+      end
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+module OpenXml
+  module Docx
+    module Properties
+      class PersonalReply < BooleanProperty
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module OpenXml
+  module Docx
+    module Properties
+      class PhoneticGuideAlignment < ValueProperty
+        tag :rubyAlign
+        name "alignment"
+
+        def ok_values
+          %i(center distributeLetter distributeSpace left right rightVertical)
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+module OpenXml
+  module Docx
+    module Properties
+      class PhoneticGuideBaseFontSize < PositiveIntegerProperty
+        tag :hpsBaseText
+        name "base_font_size"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+module OpenXml
+  module Docx
+    module Properties
+      class PhoneticGuideFontSize < PositiveIntegerProperty
+        tag :hps
+        name "font_size"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+module OpenXml
+  module Docx
+    module Properties
+      class PhoneticGuideFontSizeRaise < PositiveIntegerProperty
+        tag :hpsRaise
+        name "font_size_raise"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module OpenXml
+  module Docx
+    module Properties
+      class PhoneticGuideLanguage < ValueProperty
+        tag :lid
+        name "language"
+
+        def valid?
+          value =~ /[a-z]{2}-[A-Z]{2}/
+        end
+
+        def invalid_message
+          "Invalid #{name}: must be a language code (RFC 4646)"
+        end
+
+      end
+    end
+  end
+end

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

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