ooxml_parser 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f40b6ee146d2fa4c06246636b63931ec3c178a2c
-  data.tar.gz: 08e151b4a17546c6787000bac1d727687ff6f5b5
+  metadata.gz: 17ff610450bb961ad457f38aa206097940893f58
+  data.tar.gz: bcfe11a7a961f9a103eb8c047fb503e324d05bb3
 SHA512:
-  metadata.gz: 15187c6a9a8ac851637a1d9bfaa1f69cb651f6d22533fa66cb3b1c97c6960494daa6e3a82a2c38fec149c9c7d117289dc946273ee5b2626927b60627986f9b67
-  data.tar.gz: a1bfd37779ec4e6003a71e90f5eaed425eeca04bfb7d849e523f21b567413ad958fb227acb55cf7a15d3d97590e391a590953207451b880751e7b0d4b70fb075
+  metadata.gz: 03f3590091b03d708883a052300a754e9e94b64c55fbc85564514d3194d8bf3e9e1927069eaa30ee2aea0a095e77a089c0a899029eceb5f60394064869e6c59c
+  data.tar.gz: 4c7eb4fa0cf09ced780de674a48acd4939b29b01bb09b0e240627cc1654a1f90a945c738dba76d0e59db3c88ee859028f3dda38b4990c8165bc9adf9b200ef67

data/README.md

@@ -11,16 +11,17 @@ _ooxml_parser_ is a Ooxml files (docx, xlsx, pptx) parser written in Ruby.
 Parse a docx file
 
     require 'ooxml_parser'
-    docx = OoxmlParser::DocxParser.parse_docx('spec/docx_examples/document_properties/page_count.docx')
+    docx = OoxmlParser::Parser.parse('spec/document/document_properties/page_count.docx')
     p docx.document_properties.pages # 2
     
     
 ## Configuration
 
-Set units of mesaurements:
-Possible units are `:points`, `:centimeters`, `:dxa`, `:inches`, `:emu`
-Default is `:centimeters`
+### Accuracy
+
+Accuracy of digits in fraction part
+Default is 2 digits in fraction part
 
     OoxmlParser.configure do |config|
-      config.units = :points
+      config.accuracy = 3
     end

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

@@ -0,0 +1,19 @@
+module OoxmlParser
+  # Chart Style
+  class ChartStyle < OOXMLDocumentObject
+    attr_accessor :style_number
+
+    # Parse ChartStyle
+    # @param [Nokogiri::XML:Node] node with Relationships
+    # @return [ChartStyle] result of parsing
+    def parse(node)
+      node.xpath('*').each do |node_child|
+        case node_child.name
+        when 'style'
+          @style_number = node_child.attribute('val').value.to_i
+        end
+      end
+      self
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+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
+    def parse(node)
+      node.xpath('*').each do |node_child|
+        case node_child.name
+        when 'oMath'
+          @math = DocxFormula.new(parent: self).parse(node_child)
+        end
+      end
+      self
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+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
+    def parse(node)
+      node.xpath('*').each do |node_child|
+        case node_child.name
+        when 'oMathPara'
+          @math_paragraph = MathParagraph.new(parent: self).parse(node_child)
+        end
+      end
+      self
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+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
+    def parse(node)
+      node.xpath('*').each do |node_child|
+        case node_child.name
+        when 'm'
+          @math_text = MathText.new(parent: self).parse(node_child)
+        end
+      end
+      self
+    end
+  end
+end

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

@@ -1,34 +1,40 @@
+require_relative 'alternate_content/choice'
+require_relative 'alternate_content/chart_style'
 require_relative 'chart/chart'
 require_relative 'drawing/docx_drawing'
-require_relative 'shape/shape'
 require_relative 'picture/old_docx_picture'
-# Class for storing fallback graphic elements
 module OoxmlParser
-  class AlternateContent
+  # Class for storing fallback graphic elements
+  class AlternateContent < OOXMLDocumentObject
     attr_accessor :office2010_content, :office2007_content
+    # @return [Choice] choice data
+    attr_accessor :choice
 
-    def self.parse(alt_content_node)
-      alternate_content = AlternateContent.new
-      alt_content_node.xpath('*').each do |alternate_content_node_child|
+    # Parse AlternateContent
+    # @param [Nokogiri::XML:Node] node with Relationships
+    # @return [AlternateContent] result of parsing
+    def parse(node)
+      node.xpath('*').each do |node_child|
         begin
-          alternate_content_node_child.xpath('w:drawing')
+          node_child.xpath('w:drawing')
         rescue Nokogiri::XML::XPath::SyntaxError # This mean it is Chart
-          case alternate_content_node_child.name
+          case node_child.name
           when 'Choice'
-            alternate_content.office2010_content = Office2010ChartStyle.parse(alternate_content_node_child)
+            @office2010_content = ChartStyle.new(parent: self).parse(node_child)
           when 'Fallback'
-            alternate_content.office2007_content = Office2007ChartStyle.parse(alternate_content_node_child)
+            @office2007_content = ChartStyle.new(parent: self).parse(node_child)
           end
           next
         end
-        case alternate_content_node_child.name
+        case node_child.name
         when 'Choice'
-          alternate_content.office2010_content = DocxDrawing.parse(alternate_content_node_child.xpath('w:drawing').first) unless alternate_content_node_child.xpath('w:drawing').first.nil?
+          @office2010_content = DocxDrawing.new(parent: self).parse(node_child.xpath('w:drawing').first) unless node_child.xpath('w:drawing').first.nil?
+          @choice = Choice.new(parent: self).parse(node_child)
         when 'Fallback'
-          alternate_content.office2007_content = OldDocxPicture.parse(alternate_content_node_child.xpath('w:pict').first) unless alternate_content_node_child.xpath('w:pict').first.nil?
+          @office2007_content = OldDocxPicture.new(parent: self).parse(node_child.xpath('w:pict').first) unless node_child.xpath('w:pict').first.nil?
         end
       end
-      alternate_content
+      self
     end
   end
 end

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

@@ -0,0 +1,20 @@
+module OoxmlParser
+  # Class for parsing `c:order` object
+  class Order < OOXMLDocumentObject
+    # @return [Integer] value of order
+    attr_accessor :value
+
+    # Parse Order
+    # @param [Nokogiri::XML:Node] node with Order
+    # @return [Order] result of parsing
+    def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'val'
+          @value = value.value.to_f
+        end
+      end
+      self
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+module OoxmlParser
+  # Class for parsing `c:idx` object
+  class SeriesIndex < OOXMLDocumentObject
+    # @return [Integer] value of index
+    attr_accessor :value
+
+    # Parse SeriesIndex
+    # @param [Nokogiri::XML:Node] node with Index
+    # @return [SeriesIndex] result of parsing
+    def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'val'
+          @value = value.value.to_f
+        end
+      end
+      self
+    end
+  end
+end

data/lib/ooxml_parser/common_parser/common_data/alternate_content/chart/chart/series/series_text/string_reference/string_cache/point/text_value.rb

@@ -0,0 +1,15 @@
+module OoxmlParser
+  # Class for parsing `c:v` object
+  class TextValue < OOXMLDocumentObject
+    # @return [String] text of value
+    attr_accessor :value
+
+    # Parse TextValue
+    # @param [Nokogiri::XML:Node] node with TextValue
+    # @return [TextValue] result of parsing
+    def parse(node)
+      @value = node.text
+      self
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+require_relative 'point/text_value'
+module OoxmlParser
+  # Class for parsing `c:pt` object
+  class Point < OOXMLDocumentObject
+    # @return [Integer] index of point
+    attr_accessor :index
+    # @return [TextValue] value of text
+    attr_accessor :text
+
+    # Parse PointCount
+    # @param [Nokogiri::XML:Node] node with PointCount
+    # @return [PointCount] result of parsing
+    def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'idx'
+          @index = value.value.to_f
+        end
+      end
+
+      node.xpath('*').each do |node_child|
+        case node_child.name
+        when 'v'
+          @text = TextValue.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/series_text/string_reference/string_cache/point_count.rb

@@ -0,0 +1,20 @@
+module OoxmlParser
+  # Class for parsing `c:ptCount` object
+  class PointCount < OOXMLDocumentObject
+    # @return [Integer] value of point count
+    attr_accessor :value
+
+    # Parse PointCount
+    # @param [Nokogiri::XML:Node] node with PointCount
+    # @return [PointCount] result of parsing
+    def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'val'
+          @value = value.value.to_f
+        end
+      end
+      self
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+require_relative 'string_cache/point_count'
+require_relative 'string_cache/point'
+module OoxmlParser
+  # Class for parsing `c:tx` object
+  class StringCache < OOXMLDocumentObject
+    # @return [StringReference] String reference of series
+    attr_accessor :point_count
+    # @return [Array, Point] array of points
+    attr_accessor :points
+
+    def initialize(parent: nil)
+      @points = []
+      @parent = parent
+    end
+
+    # Parse Order
+    # @param [Nokogiri::XML:Node] node with Order
+    # @return [Order] result of parsing
+    def parse(node)
+      node.xpath('*').each do |node_child|
+        case node_child.name
+        when 'ptCount'
+          @point_count = PointCount.new(parent: self).parse(node_child)
+        when 'pt'
+          @points << Point.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/series_text/string_reference.rb

@@ -0,0 +1,25 @@
+require_relative 'string_reference/string_cache'
+module OoxmlParser
+  # Class for parsing `c:strRef` object
+  class StringReference < OOXMLDocumentObject
+    # @return [String] formula
+    attr_accessor :formula
+    # @return [StringCache] cache of string
+    attr_accessor :cache
+
+    # Parse Order
+    # @param [Nokogiri::XML:Node] node with Order
+    # @return [Order] result of parsing
+    def parse(node)
+      node.xpath('*').each do |reference_child|
+        case reference_child.name
+        when 'f'
+          @formula = reference_child.text
+        when 'strCache'
+          @cache = StringCache.new(parent: self).parse(reference_child)
+        end
+      end
+      self
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+require_relative 'series_text/string_reference'
+module OoxmlParser
+  # Class for parsing `c:tx` object
+  class SeriesText < OOXMLDocumentObject
+    # @return [StringReference] String reference of series
+    attr_accessor :string
+
+    # Parse Order
+    # @param [Nokogiri::XML:Node] node with Order
+    # @return [Order] result of parsing
+    def parse(node)
+      node.xpath('*').each do |series_child|
+        case series_child.name
+        when 'strRef'
+          @string = StringReference.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.rb

@@ -0,0 +1,39 @@
+require_relative 'series/order'
+require_relative 'series/series_index'
+require_relative 'series/series_text'
+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
+    # @return [SeriesText] text of series
+    attr_accessor :text
+    # @return [Categories] categories of chart
+    attr_accessor :categories
+    # @return [DisplayLabelsProperties]
+    attr_accessor :display_labels
+
+    # Parse Series
+    # @param [Nokogiri::XML:Node] node with Series
+    # @return [Series] result of parsing
+    def parse(node)
+      node.xpath('*').each do |node_child|
+        case node_child.name
+        when 'idx'
+          @index = SeriesIndex.new(parent: self).parse(node_child)
+        when 'order'
+          @order = Order.new(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)
+        when 'dLbls'
+          @display_labels = 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/view_3d.rb

@@ -0,0 +1,32 @@
+module OoxmlParser
+  # Parsing Chart 3D view tag 'view3D'
+  class View3D < OOXMLDocumentObject
+    # @return [ValuedChild] This element specifies the amount
+    # a 3-D chart shall be rotated in the X direction
+    attr_accessor :rotation_x
+    # @return [ValuedChild] This element specifies the amount
+    # a 3-D chart shall be rotated in the Y direction
+    attr_accessor :rotation_y
+    # @return [True, False] This element specifies that the
+    # chart axes are at right angles, rather than drawn
+    # in perspective. Applies only to 3-D charts.
+    attr_accessor :right_angle_axis
+
+    # Parse View3D object
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [View3D] result of parsing
+    def parse(node)
+      node.xpath('*').each do |node_child|
+        case node_child.name
+        when 'rotX'
+          @rotation_x = ValuedChild.new(:integer, parent: self).parse(node_child)
+        when 'rotY'
+          @rotation_y = ValuedChild.new(:integer, parent: self).parse(node_child)
+        when 'rAngAx'
+          @right_angle_axis = option_enabled?(node_child)
+        end
+      end
+      self
+    end
+  end
+end

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

@@ -3,12 +3,16 @@ require_relative 'chart_cells_range'
 require_relative 'chart_legend'
 require_relative 'chart_point'
 require_relative 'display_labels_properties'
-require_relative 'chart_style/office_2007_chart_style'
-require_relative 'chart_style/office_2010_chart_style'
+require_relative 'chart/series'
+require_relative 'chart/view_3d'
 
 module OoxmlParser
   class Chart < OOXMLDocumentObject
     attr_accessor :type, :data, :grouping, :title, :legend, :display_labels, :axises, :alternate_content, :shape_properties
+    # @return [Array, Series] series of chart
+    attr_accessor :series
+    # @return [View3D] properties of 3D view
+    attr_accessor :view_3d
 
     def initialize
       @type = ''
@@ -17,6 +21,7 @@ module OoxmlParser
       @title = nil
       @legend = nil
       @axises = []
+      @series = []
     end
 
     def parse_properties(chart_prop_node)
@@ -25,18 +30,17 @@ module OoxmlParser
         when 'grouping'
           @grouping = chart_props_node_child.attribute('val').value.to_sym
         when 'ser'
+          @series << Series.new(parent: self).parse(chart_props_node_child)
           case @type
-          when :bar, :line, :area, :pie, :doughnut, :radar, :stock, :surface_3d, :column
-            val = chart_props_node_child.xpath('c:val')[0]
           when :point, :bubble
             val = chart_props_node_child.xpath('c:yVal')[0]
           else
-            next
+            val = chart_props_node_child.xpath('c:val')[0]
           end
           next if val.xpath('c:numRef').empty?
-          @data << ChartCellsRange.parse(val.xpath('c:numRef').first).dup
+          @data << ChartCellsRange.new(parent: self).parse(val.xpath('c:numRef').first).dup
         when 'dLbls'
-          @display_labels = DisplayLabelsProperties.parse(chart_props_node_child)
+          @display_labels = DisplayLabelsProperties.new(parent: self).parse(chart_props_node_child)
         end
       end
     end
@@ -44,76 +48,79 @@ module OoxmlParser
     def self.parse
       chart = Chart.new
       chart_xml = Nokogiri::XML(File.open(OOXMLDocumentObject.current_xml))
-      chart_xml.xpath('c:chartSpace/*', 'xmlns:c' => 'http://schemas.openxmlformats.org/drawingml/2006/chart').each do |chart_space_node_child|
-        case chart_space_node_child.name
-        when 'AlternateContent'
-          chart.alternate_content = AlternateContent.parse(chart_space_node_child)
-        when 'spPr'
-          chart.shape_properties = DocxShapeProperties.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?
-                case plot_area_node_child.name
-                when 'barChart'
-                  chart.type = :bar
-                  bar_dir_node = plot_area_node_child.xpath('c:barDir')
-                  unless bar_dir_node.first.nil?
-                    chart.type = :column if bar_dir_node.first.attribute('val').value == 'col'
+      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)
+            when 'spPr'
+              chart.shape_properties = DocxShapeProperties.new(parent: chart).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?
+                    case plot_area_node_child.name
+                    when 'barChart'
+                      chart.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)
+                    when 'lineChart'
+                      chart.type = :line
+                      chart.parse_properties(plot_area_node_child)
+                    when 'areaChart'
+                      chart.type = :area
+                      chart.parse_properties(plot_area_node_child)
+                    when 'bubbleChart'
+                      chart.type = :bubble
+                      chart.parse_properties(plot_area_node_child)
+                    when 'doughnutChart'
+                      chart.type = :doughnut
+                      chart.parse_properties(plot_area_node_child)
+                    when 'pieChart'
+                      chart.type = :pie
+                      chart.parse_properties(plot_area_node_child)
+                    when 'scatterChart'
+                      chart.type = :point
+                      chart.parse_properties(plot_area_node_child)
+                    when 'radarChart'
+                      chart.type = :radar
+                      chart.parse_properties(plot_area_node_child)
+                    when 'stockChart'
+                      chart.type = :stock
+                      chart.parse_properties(plot_area_node_child)
+                    when 'surface3DChart'
+                      chart.type = :surface_3d
+                      chart.parse_properties(plot_area_node_child)
+                    when 'line3DChart'
+                      chart.type = :line_3d
+                      chart.parse_properties(plot_area_node_child)
+                    when 'bar3DChart'
+                      chart.type = :bar_3d
+                      chart.parse_properties(plot_area_node_child)
+                    when 'pie3DChart'
+                      chart.type = :pie_3d
+                      chart.parse_properties(plot_area_node_child)
+                    end
                   end
-                  chart.parse_properties(plot_area_node_child)
-                when 'lineChart'
-                  chart.type = :line
-                  chart.parse_properties(plot_area_node_child)
-                when 'areaChart'
-                  chart.type = :area
-                  chart.parse_properties(plot_area_node_child)
-                when 'bubbleChart'
-                  chart.type = :bubble
-                  chart.parse_properties(plot_area_node_child)
-                when 'doughnutChart'
-                  chart.type = :doughnut
-                  chart.parse_properties(plot_area_node_child)
-                when 'pieChart'
-                  chart.type = :pie
-                  chart.parse_properties(plot_area_node_child)
-                when 'scatterChart'
-                  chart.type = :point
-                  chart.parse_properties(plot_area_node_child)
-                when 'radarChart'
-                  chart.type = :radar
-                  chart.parse_properties(plot_area_node_child)
-                when 'stockChart'
-                  chart.type = :stock
-                  chart.parse_properties(plot_area_node_child)
-                when 'surface3DChart'
-                  chart.type = :surface_3d
-                  chart.parse_properties(plot_area_node_child)
-                when 'line3DChart'
-                  chart.type = :line_3d
-                  chart.parse_properties(plot_area_node_child)
-                when 'bar3DChart'
-                  chart.type = :bar_3d
-                  chart.parse_properties(plot_area_node_child)
-                when 'pie3DChart'
-                  chart.type = :pie_3d
-                  chart.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'
-                  chart.axises << ChartAxis.parse(plot_area_node_child)
-                when 'valAx'
-                  chart.axises << ChartAxis.parse(plot_area_node_child)
+                  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
+                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)
                 end
               end
-            when 'title'
-              chart.title = ChartAxisTitle.parse(chart_node_child)
-            when 'legend'
-              chart.legend = ChartLegend.parse(chart_node_child)
             end
           end
         end