ooxml_parser 0.1.2 → 0.2.0

data/lib/ooxml_parser/common_parser/common_data/alternate_content/chart/chart_axis.rb

@@ -1,34 +1,41 @@
 require_relative 'chart_axis_title'
-# Chart Axis
 module OoxmlParser
+  # Parsing Chart axis tags 'catAx', 'valAx'
   class ChartAxis < OOXMLDocumentObject
     attr_accessor :title, :display, :position, :major_grid_lines, :minor_grid_lines
 
-    def initialize(title = ChartAxisTitle.new, display = true, major_grid_lines = false, minor_grid_lines = false)
+    def initialize(title = ChartAxisTitle.new,
+                   display = true,
+                   major_grid_lines = false,
+                   minor_grid_lines = false,
+                   parent: nil)
       @title = title
       @display = display
       @minor_grid_lines = minor_grid_lines
       @major_grid_lines = major_grid_lines
+      @parent = parent
     end
 
-    def self.parse(axis_node)
-      axis = ChartAxis.new
-      axis_node.xpath('*').each do |axis_node_child|
-        case axis_node_child.name
+    # Parse ChartAxis object
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [ChartAxis] result of parsing
+    def parse(node)
+      node.xpath('*').each do |node_child|
+        case node_child.name
         when 'delete'
-          axis.display = false if axis_node_child.attribute('val').value == '1'
+          @display = false if node_child.attribute('val').value == '1'
         when 'title'
-          axis.title = ChartAxisTitle.parse(axis_node_child)
+          @title = ChartAxisTitle.new(parent: self).parse(node_child)
         when 'majorGridlines'
-          axis.major_grid_lines = true
+          @major_grid_lines = true
         when 'minorGridlines'
-          axis.minor_grid_lines = true
+          @minor_grid_lines = true
         when 'axPos'
-          axis.position = Alignment.parse(axis_node_child.attribute('val'))
+          @position = value_to_symbol(node_child.attribute('val'))
         end
       end
-      axis.display = false if axis.title.nil?
-      axis
+      @display = false if @title.nil?
+      self
     end
   end
 end

data/lib/ooxml_parser/common_parser/common_data/alternate_content/chart/chart_axis_title.rb

@@ -1,38 +1,39 @@
-# Chart Axis Title
 module OoxmlParser
+  # Chart Axis Title `title` node
   class ChartAxisTitle < OOXMLDocumentObject
     attr_accessor :layout, :overlay, :elements
 
-    def initialize(layout = nil, overlay = nil, elements = [])
-      @layout = layout
-      @overlay = overlay
-      @elements = elements
+    def initialize(parent: nil)
+      @elements = []
+      @parent = parent
     end
 
     def nil?
       @layout.nil? && @overlay.nil? && @elements.empty?
     end
 
-    def self.parse(axis_title_node)
-      title = ChartAxisTitle.new
-      axis_title_node.xpath('*').each do |title_node_child|
-        case title_node_child.name
+    # Parse ChartAxisTitle object
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [ChartAxisTitle] result of parsing
+    def parse(node)
+      node.xpath('*').each do |node_child|
+        case node_child.name
         when 'tx'
-          title_node_child.xpath('c:rich/*').each do |rich_node_child|
+          node_child.xpath('c:rich/*').each do |rich_node_child|
             case rich_node_child.name
             when 'p'
               Presentation.current_font_style = FontStyle.new(true) # Default font style for chart title always bold
-              title.elements << Paragraph.parse(rich_node_child)
+              @elements << Paragraph.new(parent: self).parse(rich_node_child)
               Presentation.current_font_style = FontStyle.new
             end
           end
         when 'layout'
-          title.layout = OOXMLDocumentObject.option_enabled?(title_node_child)
+          @layout = option_enabled?(node_child)
         when 'overlay'
-          title.overlay = OOXMLDocumentObject.option_enabled?(title_node_child)
+          @overlay = option_enabled?(node_child)
         end
       end
-      title
+      self
     end
   end
 end

data/lib/ooxml_parser/common_parser/common_data/alternate_content/chart/chart_cells_range.rb

@@ -1,23 +1,26 @@
-# Cell Range of Chart
 module OoxmlParser
-  class ChartCellsRange
+  # Cell Range of Chart
+  class ChartCellsRange < OOXMLDocumentObject
     attr_accessor :list, :points
 
-    def initialize(list = '', points = [])
-      @list = list
-      @points = points
+    def initialize(parent: nil)
+      @list = ''
+      @points = []
+      @parent = parent
     end
 
-    def self.parse(num_ref_node)
-      chart_range = ChartCellsRange.new
-      chart_range.list = num_ref_node.xpath('c:f')[0].text.split('!').first
-      coordinates = Coordinates.parser_coordinates_range(num_ref_node.xpath('c:f')[0].text) # .split('!')[1].gsub('$', ''))
-      num_ref_node.xpath('c:numCache/c:pt').each_with_index do |point_node, index|
+    # Parse ChartCellsRange object
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [ChartCellsRange] result of parsing
+    def parse(node)
+      @list = node.xpath('c:f')[0].text.split('!').first
+      coordinates = Coordinates.parser_coordinates_range(node.xpath('c:f')[0].text) # .split('!')[1].gsub('$', ''))
+      node.xpath('c:numCache/c:pt').each_with_index do |point_node, index|
         point = ChartPoint.new(coordinates[index])
         point.value = point_node.xpath('c:v').first.text.to_f unless point_node.xpath('c:v').first.nil?
-        chart_range.points << point
+        @points << point
       end
-      chart_range
+      self
     end
   end
 end

data/lib/ooxml_parser/common_parser/common_data/alternate_content/chart/chart_legend.rb

@@ -1,11 +1,14 @@
-# Legend of Chart
 module OoxmlParser
-  class ChartLegend
+  # Legend of Chart `legend` tag
+  class ChartLegend < OOXMLDocumentObject
     attr_accessor :position, :overlay
 
-    def initialize(position = :right, overlay = false)
+    def initialize(position = :right,
+                   overlay = false,
+                   parent: nil)
       @position = position
       @overlay = overlay
+      @parent = parent
     end
 
     # Return combined data from @position and @overlay
@@ -17,17 +20,19 @@ module OoxmlParser
       @position
     end
 
-    def self.parse(legend_node)
-      legend = ChartLegend.new
-      legend_node.xpath('*').each do |legend_node_child|
-        case legend_node_child.name
+    # Parse ChartLegend object
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [ChartLegend] result of parsing
+    def parse(node)
+      node.xpath('*').each do |child_node|
+        case child_node.name
         when 'legendPos'
-          legend.position = Alignment.parse(legend_node_child.attribute('val'))
+          @position = value_to_symbol(child_node.attribute('val'))
         when 'overlay'
-          legend.overlay = true if legend_node_child.attribute('val').value.to_s == '1'
+          @overlay = true if child_node.attribute('val').value.to_s == '1'
         end
       end
-      legend
+      self
     end
   end
 end

data/lib/ooxml_parser/common_parser/common_data/alternate_content/chart/display_labels_properties.rb

@@ -1,26 +1,37 @@
-# Chart Label Properties
 module OoxmlParser
-  class DisplayLabelsProperties
+  # Chart Label Properties, parse tag `dLbls`
+  class DisplayLabelsProperties < OOXMLDocumentObject
     attr_accessor :position, :show_legend_key, :show_values, :show_x_axis_name, :show_y_axis_name
+    # @return [True, False] is category name shown
+    attr_accessor :show_category_name
+    # @return [True, False] is series name shown
+    attr_accessor :show_series_name
 
-    def initialize(show_legend_key = false, show_values = false)
+    def initialize(show_legend_key = false, show_values = false, parent: nil)
       @show_legend_key = show_legend_key
       @show_values = show_values
+      @parent = parent
     end
 
-    def self.parse(display_labels_node)
-      display_labels_properties = DisplayLabelsProperties.new
-      display_labels_node.xpath('*').each do |display_label_property_node|
-        case display_label_property_node.name
+    # Parse DisplayLabelsProperties object
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [DisplayLabelsProperties] result of parsing
+    def parse(node)
+      node.xpath('*').each do |node_child|
+        case node_child.name
         when 'dLblPos'
-          display_labels_properties.position = Alignment.parse(display_label_property_node.attribute('val'))
+          @position = value_to_symbol(node_child.attribute('val'))
         when 'showLegendKey'
-          display_labels_properties.show_legend_key = true if display_label_property_node.attribute('val').value == '1'
+          @show_legend_key = true if node_child.attribute('val').value == '1'
         when 'showVal'
-          display_labels_properties.show_values = true if display_label_property_node.attribute('val').value == '1'
+          @show_values = true if node_child.attribute('val').value == '1'
+        when 'showCatName'
+          @show_category_name = option_enabled?(node_child)
+        when 'showSerName'
+          @show_series_name = option_enabled?(node_child)
         end
       end
-      display_labels_properties
+      self
     end
   end
 end

data/lib/ooxml_parser/common_parser/common_data/alternate_content/drawing/docx_drawing/doc_properties.rb

@@ -0,0 +1,24 @@
+module OoxmlParser
+  # Class for parsing `wp:docP` tags
+  class DocProperties < OOXMLDocumentObject
+    # @return [String] title property
+    attr_accessor :title
+    # @return [String] description property
+    attr_accessor :description
+
+    # Parse DocProperties object
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [DocProperties] result of parsing
+    def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'title'
+          @title = value.value
+        when 'descr'
+          @description = value.value
+        end
+      end
+      self
+    end
+  end
+end

data/lib/ooxml_parser/common_parser/common_data/alternate_content/drawing/docx_drawing.rb

@@ -1,49 +1,63 @@
+require_relative 'docx_drawing/doc_properties'
 require_relative 'drawing_properties/docx_drawing_properties'
+require_relative 'drawing_properties/size_relative_horizontal'
+require_relative 'drawing_properties/size_relative_vertical'
 require_relative 'graphic/docx_graphic'
-# Docx Drawing Data
 module OoxmlParser
-  class DocxDrawing
+  # Class for parsing `graphic` tags
+  class DocxDrawing < OOXMLDocumentObject
     attr_accessor :type, :properties, :graphic
+    # @return [DocProperties] doc properties
+    attr_accessor :doc_properties
 
     alias picture graphic
 
-    def initialize(properties = DocxDrawingProperties.new)
+    def initialize(properties = DocxDrawingProperties.new, parent: nil)
       @properties = properties
+      @parent = parent
     end
 
-    def self.parse(drawing_node)
-      drawing = DocxDrawing.new
-      drawing_node.xpath('*').each do |drawing_node_child|
-        case drawing_node_child.name
+    # Parse DocxDrawing
+    # @param [Nokogiri::XML:Node] node with NumberingProperties
+    # @return [DocxDrawing] result of parsing
+    def parse(node)
+      node.xpath('*').each do |node_child|
+        case node_child.name
         when 'anchor'
-          drawing.type = :flow
+          @type = :flow
         when 'inline'
-          drawing.type = :inline
+          @type = :inline
         end
-        drawing.properties.distance_from_text = DocxDrawingDistanceFromText.parse(drawing_node_child)
-        drawing.properties.wrap = DocxWrapDrawing.parse(drawing_node_child)
-        drawing_node_child.attributes.each do |key, value|
+        @properties.distance_from_text = DocxDrawingDistanceFromText.new(parent: self).parse(node_child)
+        @properties.wrap = DocxWrapDrawing.new(parent: self).parse(node_child)
+        node_child.attributes.each do |key, value|
           case key
           when 'relativeHeight'
-            drawing.properties.relative_height = value.value.to_i
+            @properties.relative_height = value.value.to_i
           end
         end
-        drawing_node_child.xpath('*').each do |content_node_child|
+        node_child.xpath('*').each do |content_node_child|
           case content_node_child.name
           when 'simplePos'
-            drawing.properties.simple_position = OOXMLCoordinates.parse(content_node_child)
+            @properties.simple_position = OOXMLCoordinates.parse(content_node_child)
           when 'extent'
-            drawing.properties.object_size = OOXMLCoordinates.parse(content_node_child, x_attr: 'cx', y_attr: 'cy')
+            @properties.object_size = OOXMLCoordinates.parse(content_node_child, x_attr: 'cx', y_attr: 'cy', unit: :emu)
           when 'graphic'
-            drawing.graphic = DocxGraphic.parse(content_node_child)
+            @graphic = DocxGraphic.new(parent: self).parse(content_node_child)
           when 'positionV'
-            drawing.properties.vertical_position = DocxDrawingPosition.parse(content_node_child)
+            @properties.vertical_position = DocxDrawingPosition.new(parent: self).parse(content_node_child)
           when 'positionH'
-            drawing.properties.horizontal_position = DocxDrawingPosition.parse(content_node_child)
+            @properties.horizontal_position = DocxDrawingPosition.new(parent: self).parse(content_node_child)
+          when 'sizeRelH'
+            @properties.size_relative_horizontal = SizeRelativeHorizontal.new(parent: self).parse(content_node_child)
+          when 'sizeRelV'
+            @properties.size_relative_vertical = SizeRelativeVertical.new(parent: self).parse(content_node_child)
+          when 'docPr'
+            @doc_properties = DocProperties.new(parent: self).parse(content_node_child)
           end
         end
       end
-      drawing
+      self
     end
   end
 end

data/lib/ooxml_parser/common_parser/common_data/alternate_content/drawing/drawing_properties/docx_drawing_distance_from_text.rb

@@ -1,23 +1,22 @@
-# Docx Drawing Distance From Text
 module OoxmlParser
-  class DocxDrawingDistanceFromText
+  # Docx Drawing Distance From Text
+  class DocxDrawingDistanceFromText < OOXMLDocumentObject
     attr_accessor :top, :bottom, :left, :right
 
-    def self.parse(distance_node)
-      distance_from_text = DocxDrawingDistanceFromText.new
-      distance_node.attributes.each do |key, value|
+    def parse(node)
+      node.attributes.each do |key, value|
         case key
         when 'distT'
-          distance_from_text.top = (value.value.to_f / 360_000.0).round(2)
+          @top = OoxmlSize.new(value.value.to_f, :emu)
         when 'distB'
-          distance_from_text.bottom = (value.value.to_f / 360_000.0).round(2)
+          @bottom = OoxmlSize.new(value.value.to_f, :emu)
         when 'distL'
-          distance_from_text.left = (value.value.to_f / 360_000.0).round(2)
+          @left = OoxmlSize.new(value.value.to_f, :emu)
         when 'distR'
-          distance_from_text.right = (value.value.to_f / 360_000.0).round(2)
+          @right = OoxmlSize.new(value.value.to_f, :emu)
         end
       end
-      distance_from_text
+      self
     end
   end
 end

data/lib/ooxml_parser/common_parser/common_data/alternate_content/drawing/drawing_properties/docx_drawing_position.rb

@@ -1,35 +1,28 @@
-# Docx Drawing Position
 module OoxmlParser
-  class DocxDrawingPosition
+  # Docx Drawing Position
+  class DocxDrawingPosition < OOXMLDocumentObject
     attr_accessor :relative_from, :offset, :align
 
-    def self.parse(drawing_position_node)
-      position = DocxDrawingPosition.new
-      position.relative_from = case drawing_position_node.attribute('relativeFrom').value
-                               when 'leftMargin'
-                                 :left_margin
-                               when 'rightMargin'
-                                 :right_margin
-                               when 'bottomMargin'
-                                 :bottom_margin
-                               when 'topMargin'
-                                 :top_margin
-                               when 'insideMargin'
-                                 :inside_margin
-                               when 'outsideMargin'
-                                 :outside_margin
-                               else
-                                 drawing_position_node.attribute('relativeFrom').value.to_sym
-                               end
-      drawing_position_node.xpath('*').each do |position_node_child|
-        case position_node_child.name
+    # Parse DocxDrawingPosition object
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [DocxDrawingPosition] result of parsing
+    def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'relativeFrom'
+          @relative_from = value_to_symbol(value)
+        end
+      end
+
+      node.xpath('*').each do |node_child|
+        case node_child.name
         when 'posOffset', 'pctPosHOffset', 'pctPosVOffset'
-          position.offset = (position_node_child.text.to_f / 360_000.0).round(3)
+          @offset = OoxmlSize.new(node_child.text.to_f, :emu)
         when 'align'
-          position.align = position_node_child.text.to_sym
+          @align = node_child.text.to_sym
         end
       end
-      position
+      self
     end
   end
 end

data/lib/ooxml_parser/common_parser/common_data/alternate_content/drawing/drawing_properties/docx_drawing_properties.rb

@@ -1,11 +1,14 @@
 require_relative 'ooxml_coordinates'
+require_relative 'ooxml_size'
 require_relative 'docx_drawing_distance_from_text'
 require_relative 'docx_drawing_position'
 require_relative 'docx_wrap_drawing'
 # Docx Drawing Properties
 module OoxmlParser
-  class DocxDrawingProperties
+  class DocxDrawingProperties < OOXMLDocumentObject
     attr_accessor :distance_from_text, :simple_position, :wrap, :object_size, :vertical_position, :horizontal_position,
                   :relative_height
+    attr_accessor :size_relative_horizontal
+    attr_accessor :size_relative_vertical
   end
 end

data/lib/ooxml_parser/common_parser/common_data/alternate_content/drawing/drawing_properties/docx_wrap_drawing.rb

@@ -1,39 +1,42 @@
-# Docx Wrap Drawing
 module OoxmlParser
-  class DocxWrapDrawing
+  # Docx Wrap Drawing
+  class DocxWrapDrawing < OOXMLDocumentObject
     attr_accessor :wrap_text, :distance_from_text
 
-    def initialize(wrap_text = :none)
-      @wrap_text = wrap_text
+    def initialize(parent: nil)
+      @wrap_text = :none
+      @parent = parent
     end
 
-    def self.parse(drawing_node)
-      wrap = DocxWrapDrawing.new
-      unless drawing_node.attribute('behindDoc').nil?
-        wrap.wrap_text = :behind if drawing_node.attribute('behindDoc').value == '1'
-        wrap.wrap_text = :infront if drawing_node.attribute('behindDoc').value == '0'
+    # Parse DocxWrapDrawing object
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [DocxWrapDrawing] result of parsing
+    def parse(node)
+      unless node.attribute('behindDoc').nil?
+        @wrap_text = :behind if node.attribute('behindDoc').value == '1'
+        @wrap_text = :infront if node.attribute('behindDoc').value == '0'
       end
-      drawing_node.xpath('*').each do |wrap_node|
-        case wrap_node.name
+      node.xpath('*').each do |node_child|
+        case node_child.name
         when 'wrapSquare'
-          wrap.wrap_text = :square
-          wrap.distance_from_text = DocxDrawingDistanceFromText.parse(wrap_node)
+          @wrap_text = :square
+          @distance_from_text = DocxDrawingDistanceFromText.new(parent: self).parse(node_child)
           break
         when 'wrapTight'
-          wrap.wrap_text = :tight
-          wrap.distance_from_text = DocxDrawingDistanceFromText.parse(wrap_node)
+          @wrap_text = :tight
+          @distance_from_text = DocxDrawingDistanceFromText.new(parent: self).parse(node_child)
           break
         when 'wrapThrough'
-          wrap.wrap_text = :through
-          wrap.distance_from_text = DocxDrawingDistanceFromText.parse(wrap_node)
+          @wrap_text = :through
+          @distance_from_text = DocxDrawingDistanceFromText.new(parent: self).parse(node_child)
           break
         when 'wrapTopAndBottom'
-          wrap.wrap_text = :topbottom
-          wrap.distance_from_text = DocxDrawingDistanceFromText.parse(wrap_node)
+          @wrap_text = :topbottom
+          @distance_from_text = DocxDrawingDistanceFromText.new(parent: self).parse(node_child)
           break
         end
       end
-      wrap
+      self
     end
   end
 end

data/lib/ooxml_parser/common_parser/common_data/alternate_content/drawing/drawing_properties/ooxml_coordinates.rb

@@ -4,8 +4,16 @@ module OoxmlParser
     attr_accessor :x, :y
 
     def initialize(x, y)
-      @x = x
-      @y = y
+      @x = if x.is_a?(OoxmlSize)
+             x
+           else
+             OoxmlSize.new(x)
+           end
+      @y = if y.is_a?(OoxmlSize)
+             y
+           else
+             OoxmlSize.new(y)
+           end
     end
 
     def to_s
@@ -23,10 +31,12 @@ module OoxmlParser
     # @param position_node [Nokogiri::XML:Element] node to parse
     # @param x_attr [String] name of x attribute
     # @param y_attr [String] name of y attribute
-    # @param delimiter [Float] delimiter to devise values
+    # @param unit [Symbol] unit in which data is stored
     # @return [OOXMLCoordinates] result of parsing
-    def self.parse(position_node, x_attr: 'x', y_attr: 'y', delimiter: OoxmlParser.configuration.units_delimiter)
-      OOXMLCoordinates.new((position_node.attribute(x_attr).value.to_f / delimiter).round(3), (position_node.attribute(y_attr).value.to_f / delimiter).round(3))
+    def self.parse(position_node, x_attr: 'x', y_attr: 'y', unit: :dxa)
+      return if position_node.attribute(x_attr).nil? || position_node.attribute(y_attr).nil?
+      OOXMLCoordinates.new(OoxmlSize.new(position_node.attribute(x_attr).value.to_f, unit),
+                           OoxmlSize.new(position_node.attribute(y_attr).value.to_f, unit))
     end
   end
 end