openxml-drawingml 0.1.0 → 0.2.0

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

@@ -0,0 +1,13 @@
+require "openxml/drawingml/properties/line_property"
+
+module OpenXml
+  module DrawingML
+    module Properties
+      class Outline < LineProperty
+        namespace :a
+        tag :ln
+
+      end
+    end
+  end
+end

data/lib/openxml/drawingml/properties/outline_reference.rb

@@ -0,0 +1,13 @@
+require "openxml/drawingml/properties/style_matrix_reference_property"
+
+module OpenXml
+  module DrawingML
+    module Properties
+      class OutlineReference < StyleMatrixReferenceProperty
+        namespace :a
+        tag :lnRef
+
+      end
+    end
+  end
+end

data/lib/openxml/drawingml/properties/paragraph_properties.rb

@@ -0,0 +1,78 @@
+module OpenXml
+  module DrawingML
+    module Properties
+      class ParagraphProperties < OpenXml::Properties::ComplexProperty
+        include OpenXml::ContainsProperties
+        namespace :a
+        tag :pPr
+
+        attribute :alignment, displays_as: :algn, one_of: %i{ ctr dist just justLow l r thaiDist }
+        attribute :default_tab_size, displays_as: :defTabSz, expects: :coordinate
+        attribute :east_asian_line_break, displays_as: :eaLnBrk, expects: :boolean
+        attribute :vertical_alignment, displays_as: :fontAlgn, one_of: %i{ auto b base ctr t }
+        attribute :hanging_punctuation, displays_as: :hangingPunct, expects: :boolean
+        attribute :indent, expects: :indent_range
+        attribute :latin_line_break, displays_as: :latinLnBrk, expects: :boolean
+        attribute :level, displays_as: :lvl, in_range: 0..8
+        attribute :left_margin, displays_as: :marL, expects: :text_margin
+        attribute :right_margin, displays_as: :marR, expects: :text_margin
+        attribute :right_to_left, displays_as: :rtl, expects: :boolean
+
+        property :line_spacing
+        property :space_before
+        property :space_after
+
+        property_choice do
+          property :bullet_color
+          value_property :bullet_color_matches_text, as: :bullet_color_text
+        end
+
+        property_choice do
+          value_property :bullet_size_matches_text, as: :bullet_size_text
+          value_property :bullet_size_percent
+          value_property :bullet_size_points
+        end
+
+        property_choice do
+          value_property :bullet_font_matches_text, as: :bullet_font_text
+          value_property :bullet_font
+        end
+
+        property_choice do
+          value_property :disable_bullets, as: :bullet_style_none
+          property :autonumbered_bullets, as: :bullet_style_auto_numbered
+          property :character_bullets, as: :bullet_style_character
+          property :blip_bullets, as: :bullet_style_blip
+        end
+
+        property :tab_list
+        property :default_run_properties
+        property :extension_list
+
+      private
+
+        def coordinate(value)
+          message = "Invalid coordinate: Must either be an integer or include units"
+          is_integer = value.is_a?(Integer)
+          is_measure = value.is_a?(String) && value =~ OpenXml::DrawingML::ST_UniversalMeasure
+          raise ArgumentError, message unless is_integer || is_measure
+        end
+
+        def indent_range(value)
+          message = "Invalid indentation range: Must be an integer between -51,206,400 and 51,206,400 or include units"
+          is_integer_in_range = value.is_a?(Integer) && (-51_206_400..51_206_400).cover?(value)
+          is_measure = value.is_a?(String) && value =~ OpenXml::DrawingML::ST_UniversalMeasure
+          raise ArgumentError, message unless is_integer_in_range || is_measure
+        end
+
+        def text_margin(value)
+          message = "Invalid text margin: Must be an integer between 0 and 51,206,400 or include units"
+          is_integer_in_range = value.is_a?(Integer) && (0..51_206_400).cover?(value)
+          is_measure = value.is_a?(String) && value =~ OpenXml::DrawingML::ST_PositiveUniversalMeasure
+          raise ArgumentError, message unless is_integer_in_range || is_measure
+        end
+
+      end
+    end
+  end
+end

data/lib/openxml/drawingml/properties/path.rb

@@ -0,0 +1,49 @@
+# require "openxml/drawingml/properties/path_close"
+# require "openxml/drawingml/properties/path_move_to"
+# require "openxml/drawingml/properties/path_line_to"
+# require "openxml/drawingml/properties/path_arc_to"
+# require "openxml/drawingml/properties/path_quadratic_bezier_to"
+# require "openxml/drawingml/properties/path_cubic_bezier_to"
+
+module OpenXml
+  module DrawingML
+    module Properties
+      class Path < OpenXml::Properties::ContainerProperty
+        include OpenXml::HasAttributes
+        namespace :a
+        tag :path
+        # TODO: Implement child classes
+        # child_classes :path_close, :path_move_to, :path_line_to, :path_arc_to,
+        #               :path_quadradic_bezier_to, :cubic_bezier_to
+
+        FILL_MODES = %i{ none norm lighten lightenLess darken darkenLess }.freeze
+
+        attribute :width, displays_as: :w, expects: :positive_coordinate
+        attribute :height, displays_as: :h, expects: :positive_coordinate
+        attribute :fill_mode, displays_as: :fill, one_of: FILL_MODES
+        attribute :stroked, displays_as: :stroke, expects: :boolean
+        attribute :extrusion_ok, displays_as: :extrusionOk, expects: :boolean
+
+        def render?
+          attributes.keys.map(&method(:send)).any? { |value| !value.nil? } || super
+        end
+
+      private
+
+        def positive_coordinate(value)
+          message = "Invalid coordinate: should either be an integer (in EMUs) or include a unit"
+          raise ArgumentError, message unless positive_universal_measure?(value) || positive_integer?(value)
+        end
+
+        def positive_universal_measure?(value)
+          value.is_a?(String) && value =~ OpenXml::DrawingML::ST_PositiveUniversalMeasure
+        end
+
+        def positive_integer?(value)
+          value.is_a?(Integer) && value >= 0
+        end
+
+      end
+    end
+  end
+end

data/lib/openxml/drawingml/properties/path_list.rb

@@ -0,0 +1,14 @@
+require "openxml/drawingml/properties/path"
+
+module OpenXml
+  module DrawingML
+    module Properties
+      class PathList < OpenXml::Properties::ContainerProperty
+        namespace :a
+        tag :pathLst
+        child_class :path
+
+      end
+    end
+  end
+end

data/lib/openxml/drawingml/properties/percentage_property.rb

@@ -0,0 +1,17 @@
+module OpenXml
+  module DrawingML
+    module Properties
+      class PercentageProperty < ValueProperty
+
+        def valid?
+          value =~ OpenXml::DrawingML::ST_Percentage
+        end
+
+        def invalid_message
+          "#{value.inspect} is an invalid value for #{name}; it must be a percentage"
+        end
+
+      end
+    end
+  end
+end

data/lib/openxml/drawingml/properties/picture_locks.rb

@@ -0,0 +1,25 @@
+module OpenXml
+  module DrawingML
+    module Properties
+      class PictureLocks < OpenXml::Properties::ComplexProperty
+        include OpenXml::ContainsProperties
+        namespace :a
+        tag :picLocks
+
+        attribute :disable_grouping, displays_as: :noGrp, expects: :boolean
+        attribute :disable_selection, displays_as: :noSelect, expects: :boolean
+        attribute :disable_rotation, displays_as: :noRot, expects: :boolean
+        attribute :disable_aspect_ratio_change, displays_as: :noChangeAspect, expects: :boolean
+        attribute :disable_moving, displays_as: :noMove, expects: :boolean
+        attribute :disable_resizing, displays_as: :noResize, expects: :boolean
+        attribute :disable_edit_points, displays_as: :noEditPoints, expects: :boolean
+        attribute :disable_adjustment_handles, displays_as: :noAdjustHandles, expects: :boolean
+        attribute :disable_change_arrowheads, displays_as: :noChangeArrowheads, expects: :boolean
+        attribute :disable_cropping, displays_as: :noCrop, expects: :boolean
+
+        property :extension_list
+
+      end
+    end
+  end
+end

data/lib/openxml/drawingml/properties/positive_integer_property.rb

@@ -0,0 +1,12 @@
+module OpenXml
+  module DrawingML
+    module Properties
+      class PositiveIntegerProperty < OpenXml::Properties::PositiveIntegerProperty
+        private def value_attribute
+          "val"
+        end
+
+      end
+    end
+  end
+end

data/lib/openxml/drawingml/properties/positive_percentage_property.rb

@@ -0,0 +1,17 @@
+module OpenXml
+  module DrawingML
+    module Properties
+      class PositivePercentageProperty < ValueProperty
+
+        def valid?
+          value =~ OpenXml::DrawingML::ST_PositivePercentage
+        end
+
+        def invalid_message
+          "#{value.inspect} is an invalid value for #{name}; it must be a positive percentage"
+        end
+
+      end
+    end
+  end
+end

data/lib/openxml/drawingml/properties/preset_dash_style.rb

@@ -0,0 +1,16 @@
+module OpenXml
+  module DrawingML
+    module Properties
+      class PresetDashStyle < ValueProperty
+        namespace :a
+        tag :prstDash
+
+        def ok_values
+          %i{ dash dashDot dot lgDash lgDashDot lgDashDotDot solid sysDash
+              sysDashDot sysDashDotDot sysDot }
+        end
+
+      end
+    end
+  end
+end

data/lib/openxml/drawingml/properties/preset_geometry.rb

@@ -0,0 +1,59 @@
+module OpenXml
+  module DrawingML
+    module Properties
+      class PresetGeometry < OpenXml::Properties::ComplexProperty
+        include OpenXml::ContainsProperties
+        namespace :a
+        tag :prstGeom
+
+        PRESET_GEOMETRIES = %i{
+          accentBorderCallout1 accentBorderCallout2 accentBorderCallout3
+          accentCallout1 accentCallout2 accentCallout3 actionButtonBackPrevious
+          actionButtonBeginning actionButtonBlank actionButtonDocument
+          actionButtonEnd actionButtonForwardNext actionButtonHelp
+          actionButtonHome actionButtonInformation actionButtonMovie
+          actionButtonReturn actionButtonSound arc bentArrow bentConnector2
+          bentConnector3 bentConnector4 bentConnector5 bentUpArrow bevel
+          blockArc borderCallout1 borderCallout2 borderCallout3 bracePair
+          bracketPair callout1 callout2 callout3 can chartPlus chartStar chartX
+          chevron chord circularArrow cloud cloudCallout corner cornerTabs cube
+          curvedConnector2 curvedConnector3 curvedConnector4 curvedConnector5
+          curvedDownArrow curvedLeftArrow curvedRightArrow curvedUpArrow
+          decagon diagStripe diamond dodecagon donut doubleWave downArrow
+          downArrowCallout ellipse ellipseRibbon ellipseRibbon2
+          flowChartAlternateProcess flowChartCollate flowChartConnector
+          flowChartDecision flowChartDelay flowChartDisplay flowChartDocument
+          flowChartExtract flowChartInputOutput flowChartInternalStorage
+          flowChartMagneticDisk flowChartMagneticDrum flowChartMagneticTape
+          flowChartManualInput flowChartManualOperation flowChartMerge
+          flowChartMultidocument flowChartOfflineStorage flowChartOffpageConnector
+          flowChartOnlineStorage flowChartOr flowChartPredefinedProcess
+          flowChartPreparation flowChartProcess flowChartPunchedCard
+          flowChartPunchedTape flowChartSort flowChartSummingJunction
+          flowChartTerminator foldedCorner frame funnel gear6 gear9 halfFrame
+          heart heptagon hexagon homePlate horizontalScroll irregularSeal1
+          irregularSeal2 leftArrow leftArrowCallout leftBrace leftBracket
+          leftCircularArrow leftRightArrow leftRightArrowCallout
+          leftRightCircularArrow leftRightRibbon leftRightUpArrow leftUpArrow
+          lightningBolt line lineInv mathDivide mathEqual mathMinu mathMultiply
+          mathNotEqual mathPlus moon nonIsoscelesTrapezoid noSmoking
+          notchedRightArrow octagon parallelogram pentagon pie pieWedge plaque
+          plaqueTabs plus quadArrow quadArrowCallout rect ribbon ribbon2
+          rightArrow rightArrowCallout rightBrace rightBracket round1Rect
+          round2DiagRect round2SameRect roundRect rtTriangle smileyFace
+          snip1Rect snip2DiagRect snip2SameRect snipRoundRect squareTabs star10
+          star12 star16 star24 star32 star4 star5 star6 star7 star8
+          straightConnector1 stripedRightArrow sun swooshArrow teardrop
+          trapezoid triangle upArrow upArrowCallout upDownArrow upDownArrowCallout
+          uturnArrow verticalScroll wave wedgeEllipseCallout wedgeRectCallout
+          wedgeRoundRectCallout
+        }.freeze
+
+        attribute :shape, displays_as: :prst, one_of: PRESET_GEOMETRIES
+
+        property :shape_adjustment_list
+
+      end
+    end
+  end
+end

data/lib/openxml/drawingml/properties/preset_text_warp.rb

@@ -0,0 +1,25 @@
+module OpenXml
+  module DrawingML
+    module Properties
+      class PresetTextWarp < OpenXml::Properties::ComplexProperty
+        namespace :a
+        tag :prstTxWarp
+
+        PRESET_WARPS = %i{
+          textArchDown textArchDownPour textArchUp textArchUpPour textButton
+          textButtonPour textCanDown textCanUp textCascadeDown textCascadeUp
+          textChevron textChevronInverted textCircle textCirclePour
+          textCurveDown textCurveUp textDeflate textDeflateBottom
+          textDeflateInflate textDeflateInflateDeflate textDeflateTop
+          textDoubleWave1 textFadeDown textFadeLeft textFadeRight textFadeUp
+          textInflate textInflateBottom textInflateTop textNoShape textPlain
+          textRingInside textRingOutside textSlantDown textSlantUp textStop
+          textTriangle textTriangleInverted textWave1 textWave2 textWave4
+        }.freeze
+
+        attribute :preset, displays_as: :prst, one_of: PRESET_WARPS
+
+      end
+    end
+  end
+end

data/lib/openxml/drawingml/properties/quick_time_file.rb

@@ -0,0 +1,17 @@
+module OpenXml
+  module DrawingML
+    module Properties
+      class QuickTimeFile < OpenXml::Properties::ComplexProperty
+        include OpenXml::ContainsProperties
+        namespace :a
+        tag :quickTimeFile
+
+        attribute :link, namespace: :r, expects: :string, required: true
+
+        property :extension_list
+
+      end
+    end
+  end
+end
+

data/lib/openxml/drawingml/properties/relative_rectangle_property.rb

@@ -0,0 +1,13 @@
+module OpenXml
+  module DrawingML
+    module Properties
+      class RelativeRectangleProperty < OpenXml::Properties::ComplexProperty
+        attribute :bottom_offset, displays_as: :b, expects: :percentage
+        attribute :left_offset, displays_as: :l, expects: :percentage
+        attribute :right_offset, displays_as: :r, expects: :percentage
+        attribute :top_offset, displays_as: :t, expects: :percentage
+
+      end
+    end
+  end
+end

data/lib/openxml/drawingml/properties/right_to_left.rb

@@ -0,0 +1,11 @@
+module OpenXml
+  module DrawingML
+    module Properties
+      class RightToLeft < SimpleBooleanProperty
+        namespace :a
+        tag :rtl
+
+      end
+    end
+  end
+end

data/lib/openxml/drawingml/properties/run_properties.rb

@@ -0,0 +1,93 @@
+module OpenXml
+  module DrawingML
+    module Properties
+      class RunProperties < OpenXml::Properties::ComplexProperty
+        include OpenXml::ContainsProperties
+        namespace :a
+        tag :rPr
+
+        UNDERLINE_STYLES = %i{
+          dash dashHeavy dashLong dashLongHeavy dbl dotDash dotDashHeavy
+          dotDotDash dotDotDashHeavy dotted dottedHeavy heavy none sng wavy
+          wavyDbl wavyHeavy words
+        }.freeze
+
+        attribute :alternative_language, displays_as: :altLang, expects: :string
+        attribute :bold, displays_as: :b, expects: :boolean
+        attribute :baseline, expects: :percentage
+        attribute :bookmark_target, displays_as: :bmk, expects: :string
+        attribute :capitalization, displays_as: :cap, one_of: %i{ all none small }
+        attribute :dirty, expects: :boolean
+        attribute :spelling_error, displays_as: :err, expects: :boolean
+        attribute :italic, displays_as: :i, expects: :boolean
+        attribute :kerning, displays_as: :kern, expects: :integer, in_range: (0..400_000)
+        attribute :kumimoji, expects: :boolean
+        attribute :language, displays_as: :lang, expects: :string
+        attribute :no_proofing, displays_as: :noProof, expects: :boolean
+        attribute :normalize_heights, displays_as: :normalizeH, expects: :boolean
+        attribute :smart_tag_clean, displays_as: :smtClean, expects: :boolean
+        attribute :smart_tag_id, displays_as: :smtId, expects: :positive_integer
+        attribute :spacing, displays_as: :spc, expects: :point
+        attribute :strikethrough, displays_as: :strike, one_of: %i{ dblStrike noStrike sngStrike }
+        attribute :font_size, displays_as: :sz, expects: :integer, in_range: (100..400_000)
+        attribute :underline_style, displays_as: :u, one_of: UNDERLINE_STYLES
+
+        property :outline
+
+        property_choice do
+          value_property :no_fill, as: :fill_none
+          property :solid_fill, as: :fill_solid
+          property :gradient_fill, as: :fill_gradient
+          property :pattern_fill, as: :fill_pattern
+          property :blip_fill, as: :fill_blip
+          value_property :inherit_group_fill, as: :fill_group
+        end
+
+        property_choice do
+          property :effect_list
+          property :effect_dag
+        end
+
+        property :highlight
+
+        property_choice do
+          value_property :underline_inherits, as: :underline_text
+          property :underline
+        end
+
+        property_choice do
+          value_property :underline_fill_inherits, as: :underline_fill_text
+          property :underline_fill
+        end
+
+        value_property :latin_font
+        value_property :east_asian_font
+        value_property :complex_script_font
+        value_property :symbol_font
+
+        property :hyperlink_click
+        property :hyperlink_mouse_over
+
+        value_property :right_to_left
+
+        property :extension_list
+
+      private
+
+        def point(value)
+          message = "Invalid point: Must either be an integer between -400,000 and 400,000 or include units"
+          raise ArgumentError, message unless valid_point?(value) || valid_measure?(value)
+        end
+
+        def valid_point?(value)
+          value.is_a?(Integer) && (-400_000..400_000).cover?(value)
+        end
+
+        def valid_measure?(value)
+          value.is_a?(String) && value =~ OpenXml::DrawingML::ST_UniversalMeasure
+        end
+
+      end
+    end
+  end
+end