ooxml_parser 0.7.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee9d17ca1564f942a23f3ec27f80e47c92720dcc772f78ce9c05f5b4a083aab4
-  data.tar.gz: c7aacc7ac67a9e03aab11180a3d0815c985f10e99494e14ddb65dafc0996d722
+  metadata.gz: d8e3e91e0a460a222a1b728590f787326cc5dcccbb08ca49609dde048038592a
+  data.tar.gz: 75cafd238d3318956e9df7ae7101914d7ab66d7719ecbbb8eac7c6ad620330fd
 SHA512:
-  metadata.gz: c9962f8a0a55810dcfe9fccf3f5915059eb1ea89343054fdaefbc835aa8bfdcbd6f492e1684e3944579b90196bf3cde395f34384411f3e8e27fcbb77a89d7e0a
-  data.tar.gz: c3422025469da1f6a10c385a0b7bb06d499aaa4e8f6c9c897f40b22a4caf0927288bcd9807e9e859b60f1017e5d31e00caba66dfc29b9d928dd156b5f471abd1
+  metadata.gz: e6f5ca51269103d59ebb7199dd98dd123dbc6b4a7d007f2a41a08ba7f26f3291433cb5d4188e0218e0d5d87b3066d9e4513b7ce75b3a49b4a74e18252acb465f
+  data.tar.gz: a155b362cb64c70a70a367fb99ec499c9b9eb282deeb1451f77a99efecae19a4f549f76178643889011e5dc3831eca2f02ff8cb6b9bbc619a4de3511aa86845c

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

@@ -38,7 +38,7 @@ module OoxmlParser
       @legend = nil
       @axises = []
       @series = []
-      @parent = parent
+      super
     end
 
     # Parse properties of Chart
@@ -74,94 +74,101 @@ module OoxmlParser
     extend Gem::Deprecate
     deprecate :data, 'series points interface', 2020, 1
 
-    # Parse  Chart
-    # @param parent [OOOXMLDocumentObject] parent of chart
+    # Parse Chart data
     # @return [Chart] result of parsing
-    def self.parse(parent: nil)
-      chart = Chart.new(parent: parent)
-      chart_xml = chart.parse_xml(OOXMLDocumentObject.current_xml)
+    def parse
+      chart_xml = parse_xml(OOXMLDocumentObject.current_xml)
       chart_xml.xpath('*').each do |chart_node|
         case chart_node.name
         when 'chartSpace'
           chart_node.xpath('*').each do |chart_space_node_child|
             case chart_space_node_child.name
             when 'AlternateContent'
-              chart.alternate_content = AlternateContent.new(parent: chart).parse(chart_space_node_child)
+              @alternate_content = AlternateContent.new(parent: self).parse(chart_space_node_child)
             when 'spPr'
-              chart.shape_properties = DocxShapeProperties.new(parent: chart).parse(chart_space_node_child)
+              @shape_properties = DocxShapeProperties.new(parent: self).parse(chart_space_node_child)
             when 'chart'
               chart_space_node_child.xpath('*').each do |chart_node_child|
                 case chart_node_child.name
                 when 'plotArea'
                   chart_node_child.xpath('*').each do |plot_area_node_child|
-                    next unless chart.type.empty?
+                    next unless type.empty?
 
                     case plot_area_node_child.name
                     when 'barChart'
-                      chart.type = :bar
+                      @type = :bar
                       bar_dir_node = plot_area_node_child.xpath('c:barDir')
-                      chart.type = :column if bar_dir_node.first.attribute('val').value == 'col'
-                      chart.parse_properties(plot_area_node_child)
+                      @type = :column if bar_dir_node.first.attribute('val').value == 'col'
+                      parse_properties(plot_area_node_child)
                     when 'lineChart'
-                      chart.type = :line
-                      chart.parse_properties(plot_area_node_child)
+                      @type = :line
+                      parse_properties(plot_area_node_child)
                     when 'areaChart'
-                      chart.type = :area
-                      chart.parse_properties(plot_area_node_child)
+                      @type = :area
+                      parse_properties(plot_area_node_child)
                     when 'bubbleChart'
-                      chart.type = :bubble
-                      chart.parse_properties(plot_area_node_child)
+                      @type = :bubble
+                      parse_properties(plot_area_node_child)
                     when 'doughnutChart'
-                      chart.type = :doughnut
-                      chart.parse_properties(plot_area_node_child)
+                      @type = :doughnut
+                      parse_properties(plot_area_node_child)
                     when 'pieChart'
-                      chart.type = :pie
-                      chart.parse_properties(plot_area_node_child)
+                      @type = :pie
+                      parse_properties(plot_area_node_child)
                     when 'scatterChart'
-                      chart.type = :point
-                      chart.parse_properties(plot_area_node_child)
+                      @type = :point
+                      parse_properties(plot_area_node_child)
                     when 'radarChart'
-                      chart.type = :radar
-                      chart.parse_properties(plot_area_node_child)
+                      @type = :radar
+                      parse_properties(plot_area_node_child)
                     when 'stockChart'
-                      chart.type = :stock
-                      chart.parse_properties(plot_area_node_child)
+                      @type = :stock
+                      parse_properties(plot_area_node_child)
                     when 'surface3DChart'
-                      chart.type = :surface_3d
-                      chart.parse_properties(plot_area_node_child)
+                      @type = :surface_3d
+                      parse_properties(plot_area_node_child)
                     when 'line3DChart'
-                      chart.type = :line_3d
-                      chart.parse_properties(plot_area_node_child)
+                      @type = :line_3d
+                      parse_properties(plot_area_node_child)
                     when 'bar3DChart'
-                      chart.type = :bar_3d
-                      chart.parse_properties(plot_area_node_child)
+                      @type = :bar_3d
+                      parse_properties(plot_area_node_child)
                     when 'pie3DChart'
-                      chart.type = :pie_3d
-                      chart.parse_properties(plot_area_node_child)
+                      @type = :pie_3d
+                      parse_properties(plot_area_node_child)
                     end
                   end
-                  chart_node_child.xpath('*').each do |plot_area_node_child|
-                    case plot_area_node_child.name
-                    when 'catAx', 'valAx'
-                      chart.axises << ChartAxis.new(parent: chart).parse(plot_area_node_child)
-                    end
-                  end
-                  chart.plot_area = PlotArea.new(parent: chart).parse(chart_node_child)
+                  parse_axis(chart_node_child)
+                  @plot_area = PlotArea.new(parent: self).parse(chart_node_child)
                 when 'title'
-                  chart.title = ChartAxisTitle.new(parent: chart).parse(chart_node_child)
+                  @title = ChartAxisTitle.new(parent: self).parse(chart_node_child)
                 when 'legend'
-                  chart.legend = ChartLegend.new(parent: chart).parse(chart_node_child)
+                  @legend = ChartLegend.new(parent: self).parse(chart_node_child)
                 when 'view3D'
-                  chart.view_3d = View3D.new(parent: chart).parse(chart_node_child)
+                  @view_3d = View3D.new(parent: self).parse(chart_node_child)
                 when 'pivotFmts'
-                  chart.pivot_formats = PivotFormats.new(parent: chart).parse(chart_node_child)
+                  @pivot_formats = PivotFormats.new(parent: self).parse(chart_node_child)
                 end
               end
             end
           end
         end
       end
-      chart
+      self
+    end
+
+    private
+
+    # Perform parsing of axis info
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [void]
+    def parse_axis(node)
+      node.xpath('*').each do |node_child|
+        case node_child.name
+        when 'catAx', 'valAx'
+          @axises << ChartAxis.new(parent: self).parse(node_child)
+        end
+      end
     end
   end
 end

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

@@ -8,8 +8,8 @@ module OoxmlParser
     attr_reader :pivot_formats_list
 
     def initialize(parent: nil)
-      @parent = parent
       @pivot_formats_list = []
+      super
     end
 
     # @return [Array, PivotFormat] accessor

data/lib/ooxml_parser/common_parser/common_data/alternate_content/chart/chart/plot_area/common_chart_data.rb

@@ -10,7 +10,7 @@ module OoxmlParser
 
     def initialize(parent: nil)
       @series = []
-      @parent = parent
+      super
     end
 
     # Parse CommonChartData object

data/lib/ooxml_parser/common_parser/common_data/alternate_content/chart/chart/series/series_text/string_reference/number_string_cache.rb

@@ -13,7 +13,7 @@ module OoxmlParser
 
     def initialize(parent: nil)
       @points = []
-      @parent = parent
+      super
     end
 
     # Parse Order

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

@@ -11,16 +11,12 @@ module OoxmlParser
     # @return [ValuedChild] the position of the tick labels
     attr_reader :tick_label_position
 
-    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
+    def initialize(params = {})
+      @title = params.fetch(:title, ChartAxisTitle.new)
+      @display = params.fetch(:display, true)
+      @minor_grid_lines = params.fetch(:minor_grid_lines, false)
+      @major_grid_lines = params.fetch(:major_grid_lines, false)
+      super(parent: params[:parent])
     end
 
     # Parse ChartAxis object

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

@@ -7,7 +7,7 @@ module OoxmlParser
 
     def initialize(parent: nil)
       @elements = []
-      @parent = parent
+      super
     end
 
     # @return [Boolean] if chart title is visible

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

@@ -8,7 +8,7 @@ module OoxmlParser
     def initialize(parent: nil)
       @list = ''
       @points = []
-      @parent = parent
+      super
     end
 
     # Parse ChartCellsRange object

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

@@ -5,12 +5,10 @@ module OoxmlParser
   class ChartLegend < OOXMLDocumentObject
     attr_accessor :position, :overlay
 
-    def initialize(position = :right,
-                   overlay = false,
-                   parent: nil)
-      @position = position
-      @overlay = overlay
-      @parent = parent
+    def initialize(params = {})
+      @position = params.fetch(:position, :right)
+      @overlay = params.fetch(:overlay, false)
+      super(parent: params[:parent])
     end
 
     # Return combined data from @position and @overlay

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

@@ -11,10 +11,10 @@ module OoxmlParser
     # @return [True, False] is label is deleted
     attr_reader :delete
 
-    def initialize(show_legend_key = false, show_values = false, parent: nil)
-      @show_legend_key = show_legend_key
-      @show_values = show_values
-      @parent = parent
+    def initialize(params = {})
+      @show_legend_key = params.fetch(:show_legend_key, false)
+      @show_values = params.fetch(:show_values, false)
+      super(parent: params[:parent])
     end
 
     # Parse DisplayLabelsProperties object

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

@@ -16,7 +16,7 @@ module OoxmlParser
 
     def initialize(properties = DocxDrawingProperties.new, parent: nil)
       @properties = properties
-      @parent = parent
+      super(parent: parent)
     end
 
     # Parse DocxDrawing
@@ -30,34 +30,15 @@ module OoxmlParser
         when 'inline'
           @type = :inline
         end
-        @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'
-            @properties.relative_height = value.value.to_i
-          end
-        end
         node_child.xpath('*').each do |content_node_child|
           case content_node_child.name
-          when 'simplePos'
-            @properties.simple_position = OOXMLCoordinates.parse(content_node_child)
-          when 'extent'
-            @properties.object_size = OOXMLCoordinates.parse(content_node_child, x_attr: 'cx', y_attr: 'cy', unit: :emu)
           when 'graphic'
             @graphic = DocxGraphic.new(parent: self).parse(content_node_child)
-          when 'positionV'
-            @properties.vertical_position = DocxDrawingPosition.new(parent: self).parse(content_node_child)
-          when 'positionH'
-            @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
+        @properties.parse(node_child)
       end
       self
     end

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

@@ -8,9 +8,56 @@ require_relative 'docx_wrap_drawing'
 module OoxmlParser
   # Docx Drawing Properties
   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
+    # @return [DocxDrawingDistanceFromText] distance from text
+    attr_reader :distance_from_text
+    # @return [DocxWrapDrawing] wrap of drawing
+    attr_reader :wrap
+    # @return [Integer] relative height of object
+    attr_reader :relative_height
+    # @return [OOXMLCoordinates] simple position of object
+    attr_reader :simple_position
+    # @return [OOXMLCoordinates] size of object
+    attr_reader :object_size
+    # @return [DocxDrawingPosition] vertical position
+    attr_reader :vertical_position
+    # @return [DocxDrawingPosition] horizontal position
+    attr_reader :horizontal_position
+    # @return [SizeRelativeHorizontal] size of drawing relative to horizontal
+    attr_reader :size_relative_horizontal
+    # @return [SizeRelativeVertical] size of drawing relative to vertical
+    attr_reader :size_relative_vertical
+
+    # Parse DocxDrawingProperties
+    # @param [Nokogiri::XML:Node] node with DocxDrawingProperties
+    # @return [DocxDrawingProperties] result of parsing
+    def parse(node)
+      @distance_from_text = DocxDrawingDistanceFromText.new(parent: self).parse(node)
+      @wrap = DocxWrapDrawing.new(parent: self).parse(node)
+
+      node.attributes.each do |key, value|
+        case key
+        when 'relativeHeight'
+          @relative_height = value.value.to_i
+        end
+      end
+
+      node.xpath('*').each do |content_node_child|
+        case content_node_child.name
+        when 'simplePos'
+          @simple_position = OOXMLCoordinates.parse(content_node_child)
+        when 'extent'
+          @object_size = OOXMLCoordinates.parse(content_node_child, x_attr: 'cx', y_attr: 'cy', unit: :emu)
+        when 'positionV'
+          @vertical_position = DocxDrawingPosition.new(parent: self).parse(content_node_child)
+        when 'positionH'
+          @horizontal_position = DocxDrawingPosition.new(parent: self).parse(content_node_child)
+        when 'sizeRelH'
+          @size_relative_horizontal = SizeRelativeHorizontal.new(parent: self).parse(content_node_child)
+        when 'sizeRelV'
+          @size_relative_vertical = SizeRelativeVertical.new(parent: self).parse(content_node_child)
+        end
+      end
+      self
+    end
   end
 end

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

@@ -7,7 +7,7 @@ module OoxmlParser
 
     def initialize(parent: nil)
       @wrap_text = :none
-      @parent = parent
+      super
     end
 
     # Parse DocxWrapDrawing object

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

@@ -20,7 +20,7 @@ module OoxmlParser
 
     # @return [String] result of convert of object to string
     def to_s
-      '(' + @x.to_s + '; ' + @y.to_s + ')'
+      "(#{@x}; #{@y})"
     end
 
     # Compare two OOXMLCoordinates objects

data/lib/ooxml_parser/common_parser/common_data/alternate_content/drawing/graphic/docx_graphic.rb

@@ -24,7 +24,7 @@ module OoxmlParser
         when 'chart'
           @type = :chart
           OOXMLDocumentObject.add_to_xmls_stack("#{OOXMLDocumentObject.root_subfolder}/#{OOXMLDocumentObject.get_link_from_rels(node_child.attribute('id').value)}")
-          @data = Chart.parse(parent: self)
+          @data = Chart.new(parent: self).parse
           OOXMLDocumentObject.xmls_stack.pop
         when 'wgp'
           @type = :group

data/lib/ooxml_parser/common_parser/common_data/alternate_content/drawing/graphic/shape/docx_shape/ooxml_text_box.rb

@@ -7,7 +7,7 @@ module OoxmlParser
 
     def initialize(parent: nil)
       @elements = []
-      @parent = parent
+      super
     end
 
     # Parse OOXMLTextBox object

data/lib/ooxml_parser/common_parser/common_data/alternate_content/drawing/graphic/shape/docx_shape/shape_style.rb

@@ -16,10 +16,6 @@ module OoxmlParser
     # @return [LineReference] line reference
     attr_reader :line_reference
 
-    def initialize(parent: nil)
-      @parent = parent
-    end
-
     # Parse ShapeStyle object
     # @param node [Nokogiri::XML:Element] node to parse
     # @return [ShapeStyle] result of parsing

data/lib/ooxml_parser/common_parser/common_data/alternate_content/drawing/graphic/shape/docx_shape/shape_style/effect_reference.rb

@@ -8,10 +8,6 @@ module OoxmlParser
     # @return [Color] scheme color of EffectReference
     attr_reader :scheme_color
 
-    def initialize(parent: nil)
-      @parent = parent
-    end
-
     # Parse EffectReference object
     # @param node [Nokogiri::XML:Element] node to parse
     # @return [EffectReference] result of parsing

data/lib/ooxml_parser/common_parser/common_data/alternate_content/drawing/graphic/shape/docx_shape/shape_style/fill_reference.rb

@@ -8,10 +8,6 @@ module OoxmlParser
     # @return [Color] scheme color of FillReference
     attr_reader :scheme_color
 
-    def initialize(parent: nil)
-      @parent = parent
-    end
-
     # Parse FillReference object
     # @param node [Nokogiri::XML:Element] node to parse
     # @return [FillReference] result of parsing