ooxml_parser 0.4.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba540828c5a8309f41774a4a3e8f2ab583191c861ae51f32a0a6fbfb92cf6d91
-  data.tar.gz: b747ef0164eb751ab889cb184025a1606794f0670aab618d2486a889c5d2f76a
+  metadata.gz: ee9d17ca1564f942a23f3ec27f80e47c92720dcc772f78ce9c05f5b4a083aab4
+  data.tar.gz: c7aacc7ac67a9e03aab11180a3d0815c985f10e99494e14ddb65dafc0996d722
 SHA512:
-  metadata.gz: cc16c99a930f7a68016d099c293bc58672b345eb583d599c4b5ae885dfad705b42103b0f3f79d6604ccfb03b2eb8747f9b1663ea08ed04401002a7f4cdcd4eb7
-  data.tar.gz: 4824d4244130d1e120ea6cfffb0c34471aff1d9725a60e8fe27a2c5fc04826b5b325cbcfdaaab2f12e1016fdbf88b807adaaff5301ac1d91397358c2e17f6170
+  metadata.gz: c9962f8a0a55810dcfe9fccf3f5915059eb1ea89343054fdaefbc835aa8bfdcbd6f492e1684e3944579b90196bf3cde395f34384411f3e8e27fcbb77a89d7e0a
+  data.tar.gz: c3422025469da1f6a10c385a0b7bb06d499aaa4e8f6c9c897f40b22a4caf0927288bcd9807e9e859b60f1017e5d31e00caba66dfc29b9d928dd156b5f471abd1

data/lib/ooxml_parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'ooxml_parser/common_parser/common_data/ooxml_document_object'
 require_relative 'ooxml_parser/common_parser/common_data/color'
 require_relative 'ooxml_parser/common_parser/common_data/coordinates'
@@ -17,6 +19,7 @@ require_relative 'ooxml_parser/docx_parser/docx_parser'
 require_relative 'ooxml_parser/xlsx_parser/xlsx_parser'
 require_relative 'ooxml_parser/pptx_parser/pptx_parser'
 
+# Basic class for all parser stuff
 module OoxmlParser
   class << self
     attr_writer :configuration
@@ -26,6 +29,7 @@ module OoxmlParser
     @configuration ||= Configuration.new
   end
 
+  # Reset settings to default
   def self.reset
     @configuration = Configuration.new
   end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'alternate_content/choice'
 require_relative 'alternate_content/chart_style'
 require_relative 'chart/chart'

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Chart Style
   class ChartStyle < OOXMLDocumentObject

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

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 require_relative 'choice/math_text'
 module OoxmlParser
   # Class for storing choice (for office 2014 and newer)
   # graphic data
   class Choice < OOXMLDocumentObject
     attr_accessor :math_text
+
     # Parse Choice object
     # @param node [Nokogiri::XML:Element] node to parse
     # @return [Choice] result of parsing

data/lib/ooxml_parser/common_parser/common_data/alternate_content/alternate_content/choice/math_text.rb

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+
 require_relative 'math_text/math_paragraph'
 module OoxmlParser
   # Class for storing math text
   class MathText < OOXMLDocumentObject
     attr_accessor :math_paragraph
+
     # Parse MathText object
     # @param node [Nokogiri::XML:Element] node to parse
     # @return [MathText] result of parsing

data/lib/ooxml_parser/common_parser/common_data/alternate_content/alternate_content/choice/math_text/math_paragraph.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for storing math paragraph
   class MathParagraph < OOXMLDocumentObject
     attr_accessor :math
+
     # Parse MathParagraph object
     # @param node [Nokogiri::XML:Element] node to parse
     # @return [MathParagraph] result of parsing

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

@@ -1,20 +1,36 @@
+# frozen_string_literal: true
+
 require_relative 'chart_axis'
 require_relative 'chart_cells_range'
 require_relative 'chart_legend'
 require_relative 'chart_point'
 require_relative 'display_labels_properties'
+require_relative 'chart/pivot_formats'
+require_relative 'chart/plot_area'
 require_relative 'chart/series'
 require_relative 'chart/view_3d'
 
 module OoxmlParser
+  # Class for working with Chart data
   class Chart < OOXMLDocumentObject
     attr_accessor :type, :data, :grouping, :title, :legend, :display_labels, :axises, :alternate_content, :shape_properties
+    # @return [Array, ValuedChild] array axis id
+    attr_reader :axis_ids
     # @return [Array, Series] series of chart
     attr_accessor :series
+    # @return [PivotFormats] list of pivot formats
+    attr_accessor :pivot_formats
+    # @return [PlotArea] plot area data
+    attr_accessor :plot_area
+    # @return [True, False] This element specifies that
+    # each data marker in the series has a different color.
+    # ECMA-376 (5th Edition). 21.2.2.227
+    attr_reader :vary_colors
     # @return [View3D] properties of 3D view
     attr_accessor :view_3d
 
-    def initialize
+    def initialize(parent: nil)
+      @axis_ids = []
       @type = ''
       @data = []
       @grouping = nil
@@ -22,11 +38,17 @@ module OoxmlParser
       @legend = nil
       @axises = []
       @series = []
+      @parent = parent
     end
 
+    # Parse properties of Chart
+    # @param chart_prop_node [Nokogiri::XML:Element] node to parse
+    # @return [void]
     def parse_properties(chart_prop_node)
       chart_prop_node.xpath('*').each do |chart_props_node_child|
         case chart_props_node_child.name
+        when 'axId'
+          @axis_ids << ValuedChild.new(:integer, parent: self).parse(chart_props_node_child)
         when 'grouping'
           @grouping = chart_props_node_child.attribute('val').value.to_sym
         when 'ser'
@@ -39,16 +61,25 @@ module OoxmlParser
           end
           next unless val
           next if val.xpath('c:numRef').empty?
+
           @data << ChartCellsRange.new(parent: self).parse(val.xpath('c:numRef').first).dup
         when 'dLbls'
           @display_labels = DisplayLabelsProperties.new(parent: self).parse(chart_props_node_child)
+        when 'varyColors'
+          @vary_colors = option_enabled?(chart_props_node_child)
         end
       end
     end
 
-    def self.parse
-      chart = Chart.new
-      chart_xml = Nokogiri::XML(File.open(OOXMLDocumentObject.current_xml))
+    extend Gem::Deprecate
+    deprecate :data, 'series points interface', 2020, 1
+
+    # Parse  Chart
+    # @param parent [OOOXMLDocumentObject] parent of chart
+    # @return [Chart] result of parsing
+    def self.parse(parent: nil)
+      chart = Chart.new(parent: parent)
+      chart_xml = chart.parse_xml(OOXMLDocumentObject.current_xml)
       chart_xml.xpath('*').each do |chart_node|
         case chart_node.name
         when 'chartSpace'
@@ -64,6 +95,7 @@ module OoxmlParser
                 when 'plotArea'
                   chart_node_child.xpath('*').each do |plot_area_node_child|
                     next unless chart.type.empty?
+
                     case plot_area_node_child.name
                     when 'barChart'
                       chart.type = :bar
@@ -114,12 +146,15 @@ module OoxmlParser
                       chart.axises << ChartAxis.new(parent: chart).parse(plot_area_node_child)
                     end
                   end
+                  chart.plot_area = PlotArea.new(parent: chart).parse(chart_node_child)
                 when 'title'
                   chart.title = ChartAxisTitle.new(parent: chart).parse(chart_node_child)
                 when 'legend'
                   chart.legend = ChartLegend.new(parent: chart).parse(chart_node_child)
                 when 'view3D'
                   chart.view_3d = View3D.new(parent: chart).parse(chart_node_child)
+                when 'pivotFmts'
+                  chart.pivot_formats = PivotFormats.new(parent: chart).parse(chart_node_child)
                 end
               end
             end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'pivot_formats/pivot_format'
+module OoxmlParser
+  # Parsing chart `c:pivotFmts`
+  class PivotFormats < OOXMLDocumentObject
+    # @return [Array<PivotFormat>] list of pivot formats
+    attr_reader :pivot_formats_list
+
+    def initialize(parent: nil)
+      @parent = parent
+      @pivot_formats_list = []
+    end
+
+    # @return [Array, PivotFormat] accessor
+    def [](key)
+      @pivot_formats_list[key]
+    end
+
+    # Parse PivotFormats object
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [PivotFormats] result of parsing
+    def parse(node)
+      node.xpath('*').each do |node_child|
+        case node_child.name
+        when 'pivotFmt'
+          @pivot_formats_list << PivotFormat.new(parent: self).parse(node_child)
+        end
+      end
+      self
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Parsing chart `c:pivotFmt`
+  class PivotFormat < OOXMLDocumentObject
+    # @return [ValuedChild] index of pivot
+    attr_reader :index
+    # @return [DisplayLabelsProperties] data label
+    attr_reader :data_label
+
+    # Parse PivotFormats object
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [PivotFormat] result of parsing
+    def parse(node)
+      node.xpath('*').each do |node_child|
+        case node_child.name
+        when 'idx'
+          @index = ValuedChild.new(:integer, parent: self).parse(node_child)
+        when 'dLbl'
+          @data_label = DisplayLabelsProperties.new(parent: self).parse(node_child)
+        end
+      end
+      self
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require_relative 'plot_area/common_chart_data'
+module OoxmlParser
+  # Parsing Plot Area tag 'plotArea'
+  class PlotArea < OOXMLDocumentObject
+    # @return [CommonChartData] bar chart
+    attr_reader :bar_chart
+    # @return [CommonChartData] line chart
+    attr_reader :line_chart
+    # @return [CommonChartData] area chart
+    attr_reader :area_chart
+    # @return [CommonChartData] bubble chart
+    attr_reader :bubble_chart
+    # @return [CommonChartData] pie chart
+    attr_reader :pie_chart
+    # @return [CommonChartData] radar chart
+    attr_reader :radar_chart
+    # @return [CommonChartData] stock chart
+    attr_reader :stock_chart
+    # @return [CommonChartData] surface 3D chart
+    attr_reader :surface_3d_chart
+    # @return [CommonChartData] line 3D chart
+    attr_reader :line_3d_chart
+    # @return [CommonChartData] bar 3D chart
+    attr_reader :bar_3d_chart
+    # @return [CommonChartData] pie 3D chart
+    attr_reader :pie_3d_chart
+
+    # Parse PlotArea object
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [PlotArea] result of parsing
+    def parse(node)
+      node.xpath('*').each do |node_child|
+        case node_child.name
+        when 'barChart'
+          @bar_chart = CommonChartData.new(parent: self).parse(node_child)
+        when 'lineChart'
+          @line_chart = CommonChartData.new(parent: self).parse(node_child)
+        when 'areaChart'
+          @area_chart = CommonChartData.new(parent: self).parse(node_child)
+        when 'bubbleChart'
+          @bubble_chart = CommonChartData.new(parent: self).parse(node_child)
+        when 'doughnutChart'
+          @doughnut_chart = CommonChartData.new(parent: self).parse(node_child)
+        when 'pieChart'
+          @pie_chart = CommonChartData.new(parent: self).parse(node_child)
+        when 'scatterChart'
+          @scatter_chart = CommonChartData.new(parent: self).parse(node_child)
+        when 'radarChart'
+          @radar_chart = CommonChartData.new(parent: self).parse(node_child)
+        when 'stockChart'
+          @stock_chart = CommonChartData.new(parent: self).parse(node_child)
+        when 'surface3DChart'
+          @surface_3d_chart = CommonChartData.new(parent: self).parse(node_child)
+        when 'line3DChart'
+          @line_3d_chart = CommonChartData.new(parent: self).parse(node_child)
+        when 'bar3DChart'
+          @bar_3d_chart = CommonChartData.new(parent: self).parse(node_child)
+        when 'pie3DChart'
+          @pie_3d_chart = CommonChartData.new(parent: self).parse(node_child)
+        end
+      end
+      self
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Parsing common chart data
+  class CommonChartData < OOXMLDocumentObject
+    # @return [ValuedChild] type of grouping
+    attr_reader :grouping
+    # @return [Array<Series>] series data
+    attr_reader :series
+
+    def initialize(parent: nil)
+      @series = []
+      @parent = parent
+    end
+
+    # Parse CommonChartData object
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [CommonChartData] result of parsing
+    def parse(node)
+      node.xpath('*').each do |node_child|
+        case node_child.name
+        when 'grouping'
+          @grouping = ValuedChild.new(:symbol, parent: self).parse(node_child)
+        when 'ser'
+          @series << Series.new(parent: self).parse(node_child)
+        end
+      end
+      self
+    end
+  end
+end

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

@@ -1,19 +1,26 @@
-require_relative 'series/order'
-require_relative 'series/series_index'
+# frozen_string_literal: true
+
 require_relative 'series/series_text'
+require_relative 'series/x_y_values'
 module OoxmlParser
   # Class for parsing `c:ser` object
   class Series < OOXMLDocumentObject
     # @return [Index] index of chart
-    attr_accessor :index
-    # @return [Order] order of chart
-    attr_accessor :order
+    attr_reader :index
+    # @return [ValuedChild] order of chart
+    attr_reader :order
     # @return [SeriesText] text of series
     attr_accessor :text
-    # @return [Categories] categories of chart
+    # @return [SeriesText] categories of chart
     attr_accessor :categories
     # @return [DisplayLabelsProperties]
     attr_accessor :display_labels
+    # @return [XYValues] values of series
+    attr_reader :values
+    # @return [XYValues] values of x
+    attr_reader :x_values
+    # @return [XYValues] values of y
+    attr_reader :y_values
 
     # Parse Series
     # @param [Nokogiri::XML:Node] node with Series
@@ -22,15 +29,21 @@ module OoxmlParser
       node.xpath('*').each do |node_child|
         case node_child.name
         when 'idx'
-          @index = SeriesIndex.new(parent: self).parse(node_child)
+          @index = ValuedChild.new(:integer, parent: self).parse(node_child)
         when 'order'
-          @order = Order.new(parent: self).parse(node_child)
+          @order = ValuedChild.new(:integer, parent: self).parse(node_child)
         when 'tx'
           @text = SeriesText.new(parent: self).parse(node_child)
         when 'cat'
-          @categories = Categories.new(parent: self).parse(node_child)
+          @categories = SeriesText.new(parent: self).parse(node_child)
         when 'dLbls'
           @display_labels = DisplayLabelsProperties.new(parent: self).parse(node_child)
+        when 'val'
+          @values = XYValues.new(parent: self).parse(node_child)
+        when 'xVal'
+          @x_values = XYValues.new(parent: self).parse(node_child)
+        when 'yVal'
+          @y_values = XYValues.new(parent: self).parse(node_child)
         end
       end
       self

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

@@ -1,8 +1,10 @@
-require_relative 'series_text/string_reference'
+# frozen_string_literal: true
+
+require_relative 'series_text/number_string_reference'
 module OoxmlParser
   # Class for parsing `c:tx` object
   class SeriesText < OOXMLDocumentObject
-    # @return [StringReference] String reference of series
+    # @return [NumberStringReference] String reference of series
     attr_accessor :string
 
     # Parse Order
@@ -12,12 +14,10 @@ module OoxmlParser
       node.xpath('*').each do |series_child|
         case series_child.name
         when 'strRef'
-          @string = StringReference.new(parent: self).parse(series_child)
+          @string = NumberStringReference.new(parent: self).parse(series_child)
         end
       end
       self
     end
   end
-
-  Categories = SeriesText
 end

data/lib/ooxml_parser/common_parser/common_data/alternate_content/chart/chart/series/series_text/{string_reference.rb → number_string_reference.rb}

@@ -1,11 +1,13 @@
-require_relative 'string_reference/string_cache'
+# frozen_string_literal: true
+
+require_relative 'string_reference/number_string_cache'
 module OoxmlParser
   # Class for parsing `c:strRef` object
-  class StringReference < OOXMLDocumentObject
+  class NumberStringReference < OOXMLDocumentObject
     # @return [String] formula
-    attr_accessor :formula
-    # @return [StringCache] cache of string
-    attr_accessor :cache
+    attr_reader :formula
+    # @return [NumberStringCache] cache of string
+    attr_reader :cache
 
     # Parse Order
     # @param [Nokogiri::XML:Node] node with Order
@@ -15,8 +17,8 @@ module OoxmlParser
         case reference_child.name
         when 'f'
           @formula = reference_child.text
-        when 'strCache'
-          @cache = StringCache.new(parent: self).parse(reference_child)
+        when 'strCache', 'numCache'
+          @cache = NumberStringCache.new(parent: self).parse(reference_child)
         end
       end
       self