ooxml_parser 0.4.0 → 0.7.0

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

@@ -1,12 +1,15 @@
-require_relative 'string_cache/point_count'
+# frozen_string_literal: true
+
 require_relative 'string_cache/point'
 module OoxmlParser
-  # Class for parsing `c:tx` object
-  class StringCache < OOXMLDocumentObject
+  # Class for parsing `c:tx`, `c:numCache` object
+  class NumberStringCache < OOXMLDocumentObject
+    # @return [String] Format Code
+    attr_reader :format_code
     # @return [StringReference] String reference of series
-    attr_accessor :point_count
+    attr_reader :point_count
     # @return [Array, Point] array of points
-    attr_accessor :points
+    attr_reader :points
 
     def initialize(parent: nil)
       @points = []
@@ -19,8 +22,10 @@ module OoxmlParser
     def parse(node)
       node.xpath('*').each do |node_child|
         case node_child.name
+        when 'formatCode'
+          @format_code = node_child.text
         when 'ptCount'
-          @point_count = PointCount.new(parent: self).parse(node_child)
+          @point_count = ValuedChild.new(:integer, parent: self).parse(node_child)
         when 'pt'
           @points << Point.new(parent: self).parse(node_child)
         end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'point/text_value'
 module OoxmlParser
   # Class for parsing `c:pt` object
@@ -5,7 +7,12 @@ module OoxmlParser
     # @return [Integer] index of point
     attr_accessor :index
     # @return [TextValue] value of text
-    attr_accessor :text
+    attr_reader :value
+
+    alias text value
+
+    extend Gem::Deprecate
+    deprecate :text, 'OoxmlParser::Point#value', 2020, 1
 
     # Parse PointCount
     # @param [Nokogiri::XML:Node] node with PointCount
@@ -21,7 +28,7 @@ module OoxmlParser
       node.xpath('*').each do |node_child|
         case node_child.name
         when 'v'
-          @text = TextValue.new(parent: self).parse(node_child)
+          @value = TextValue.new(parent: self).parse(node_child)
         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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for parsing `c:v` object
   class TextValue < OOXMLDocumentObject

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Class for parsing `c:xVal`, `c:yVal` object
+  class XYValues < OOXMLDocumentObject
+    # @return [NumberReference] number reference
+    attr_reader :number_reference
+
+    # Parse XYValues
+    # @param [Nokogiri::XML:Node] node with XYValues
+    # @return [XYValues] result of parsing
+    def parse(node)
+      node.xpath('*').each do |node_child|
+        case node_child.name
+        when 'numRef'
+          @number_reference = NumberStringReference.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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Parsing Chart 3D view tag 'view3D'
   class View3D < OOXMLDocumentObject

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'chart_axis/scaling'
 require_relative 'chart_axis_title'
 module OoxmlParser
@@ -43,7 +45,7 @@ module OoxmlParser
           @position = value_to_symbol(node_child.attribute('val'))
         end
       end
-      @display = false if @title.nil?
+      @display = false unless @title.visible?
       self
     end
   end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Parsing Scaling tag 'scaling'
   class Scaling < OOXMLDocumentObject

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Chart Axis Title `title` node
   class ChartAxisTitle < OOXMLDocumentObject
@@ -8,8 +10,9 @@ module OoxmlParser
       @parent = parent
     end
 
-    def nil?
-      @layout.nil? && @overlay.nil? && @elements.empty?
+    # @return [Boolean] if chart title is visible
+    def visible?
+      @layout || @overlay || !@elements.empty?
     end
 
     # Parse ChartAxisTitle object
@@ -22,9 +25,9 @@ module OoxmlParser
           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
+              root_object.default_font_style = FontStyle.new(true) # Default font style for chart title always bold
               @elements << Paragraph.new(parent: self).parse(rich_node_child)
-              Presentation.current_font_style = FontStyle.new
+              root_object.default_font_style = FontStyle.new
             end
           end
         when 'layout'

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Cell Range of Chart
   class ChartCellsRange < OOXMLDocumentObject
@@ -15,6 +17,8 @@ module OoxmlParser
     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('$', ''))
+      return self unless coordinates
+
       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?

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Legend of Chart `legend` tag
   class ChartLegend < OOXMLDocumentObject
@@ -17,6 +19,7 @@ module OoxmlParser
     # @return [Symbol] overlay and position type
     def position_with_overlay
       return "#{@position}_overlay".to_sym if overlay
+
       @position
     end
 

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

@@ -1,5 +1,7 @@
-# Single Chart Point
+# frozen_string_literal: true
+
 module OoxmlParser
+  # Single Chart Point
   class ChartPoint
     attr_accessor :coordinates, :value
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Chart Label Properties, parse tag `dLbls`
   class DisplayLabelsProperties < OOXMLDocumentObject
@@ -6,6 +8,8 @@ module OoxmlParser
     attr_accessor :show_category_name
     # @return [True, False] is series name shown
     attr_accessor :show_series_name
+    # @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
@@ -29,6 +33,8 @@ module OoxmlParser
           @show_category_name = option_enabled?(node_child)
         when 'showSerName'
           @show_series_name = option_enabled?(node_child)
+        when 'delete'
+          @delete = option_enabled?(node_child)
         end
       end
       self

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'docx_drawing/doc_properties'
 require_relative 'drawing_properties/docx_drawing_properties'
 require_relative 'drawing_properties/size_relative_horizontal'

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for parsing `wp:docP` tags
   class DocProperties < OOXMLDocumentObject

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

@@ -1,8 +1,13 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Docx Drawing Distance From Text
   class DocxDrawingDistanceFromText < OOXMLDocumentObject
     attr_accessor :top, :bottom, :left, :right
 
+    # Parse DocxDrawingDistanceFromText object
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [DocxDrawingDistanceFromText] result of parsing
     def parse(node)
       node.attributes.each do |key, value|
         case key

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Docx Drawing Position
   class DocxDrawingPosition < OOXMLDocumentObject

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

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 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
+  # Docx Drawing Properties
   class DocxDrawingProperties < OOXMLDocumentObject
     attr_accessor :distance_from_text, :simple_position, :wrap, :object_size, :vertical_position, :horizontal_position,
                   :relative_height

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Docx Wrap Drawing
   class DocxWrapDrawing < OOXMLDocumentObject

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

@@ -1,21 +1,24 @@
-# Docx Coordinates
+# frozen_string_literal: true
+
 module OoxmlParser
+  # Docx Coordinates
   class OOXMLCoordinates
     attr_accessor :x, :y
 
-    def initialize(x, y)
-      @x = if x.is_a?(OoxmlSize)
-             x
+    def initialize(x_value, y_value)
+      @x = if x_value.is_a?(OoxmlSize)
+             x_value
            else
-             OoxmlSize.new(x)
+             OoxmlSize.new(x_value)
            end
-      @y = if y.is_a?(OoxmlSize)
-             y
+      @y = if y_value.is_a?(OoxmlSize)
+             y_value
            else
-             OoxmlSize.new(y)
+             OoxmlSize.new(y_value)
            end
     end
 
+    # @return [String] result of convert of object to string
     def to_s
       '(' + @x.to_s + '; ' + @y.to_s + ')'
     end
@@ -35,6 +38,7 @@ module OoxmlParser
     # @return [OOXMLCoordinates] result of parsing
     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

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Size of some object
   class OoxmlSize
@@ -26,6 +28,9 @@ module OoxmlParser
       self
     end
 
+    # Compare this object to other
+    # @param other [Object] any other object
+    # @return [True, False] result of comparision
     def ==(other)
       (to_base_unit.value - other.to_base_unit.value).abs < 10**(OoxmlParser.configuration.accuracy + 2)
     end
@@ -34,8 +39,11 @@ module OoxmlParser
       @value.zero?
     end
 
-    def to_s
-      "#{@value} #{@unit}"
+    # @param unit [Symbol] unit in which output should be
+    # @return [String] string representation of size
+    def to_s(unit = :centimeter)
+      converted = to_unit(unit)
+      "#{converted.value.to_f} #{converted.unit}"
     end
 
     # Convert all values to one same base unit
@@ -55,7 +63,7 @@ module OoxmlParser
       when :one_240th_cm
         OoxmlSize.new(@value * 1500)
       when :dxa, :twip
-        return OoxmlSize.new(@value * 635, :emu)
+        OoxmlSize.new(@value * 635, :emu)
       when :inch
         OoxmlSize.new(@value * 914_400, :emu)
       when :spacing_point
@@ -66,6 +74,10 @@ module OoxmlParser
         OoxmlSize.new(@value * 100_000 / 50, :one_100000th_percent)
       when :one_1000th_percent
         OoxmlSize.new(@value * 100, :one_100000th_percent)
+      when :one_60000th_degree
+        OoxmlSize.new(@value, :one_60000th_degree)
+      when :degree
+        OoxmlSize.new(@value * 60_000, :one_60000th_degree)
       else
         self
       end
@@ -77,27 +89,27 @@ module OoxmlParser
       base_unit = to_base_unit
       case output_unit
       when :centimeter
-        return OoxmlSize.new((base_unit.value / 360_000).round(OoxmlParser.configuration.accuracy), output_unit)
+        OoxmlSize.new((base_unit.value / 360_000).round(OoxmlParser.configuration.accuracy), output_unit)
       when :point
-        return OoxmlSize.new((base_unit.value / 12_700).round(OoxmlParser.configuration.accuracy), output_unit)
+        OoxmlSize.new((base_unit.value / 12_700).round(OoxmlParser.configuration.accuracy), output_unit)
       when :half_point
-        return OoxmlSize.new((base_unit.value / (12_700 * 2)).round(OoxmlParser.configuration.accuracy), output_unit)
+        OoxmlSize.new((base_unit.value / (12_700 * 2)).round(OoxmlParser.configuration.accuracy), output_unit)
       when :one_eighth_point
-        return OoxmlSize.new((base_unit.value / (12_700 * 8)).round(OoxmlParser.configuration.accuracy), output_unit)
+        OoxmlSize.new((base_unit.value / (12_700 * 8)).round(OoxmlParser.configuration.accuracy), output_unit)
       when :one_100th_point
-        return OoxmlSize.new((base_unit.value / (12_700 / 100)).round(OoxmlParser.configuration.accuracy), output_unit)
+        OoxmlSize.new((base_unit.value / (12_700 / 100)).round(OoxmlParser.configuration.accuracy), output_unit)
       when :one_240th_cm
-        return OoxmlSize.new((base_unit.value / 1500).round(OoxmlParser.configuration.accuracy), output_unit)
+        OoxmlSize.new((base_unit.value / 1500).round(OoxmlParser.configuration.accuracy), output_unit)
       when :dxa, :twip
-        return OoxmlSize.new((base_unit.value / 635).round(OoxmlParser.configuration.accuracy), output_unit)
+        OoxmlSize.new((base_unit.value / 635).round(OoxmlParser.configuration.accuracy), output_unit)
       when :inch
-        return OoxmlSize.new((base_unit.value / 914_400).round(OoxmlParser.configuration.accuracy), output_unit)
+        OoxmlSize.new((base_unit.value / 914_400).round(OoxmlParser.configuration.accuracy), output_unit)
       when :percent
-        return OoxmlSize.new((base_unit.value / 50).round(OoxmlParser.configuration.accuracy), output_unit)
+        OoxmlSize.new((base_unit.value / 50).round(OoxmlParser.configuration.accuracy), output_unit)
       when :spacing_point
-        return OoxmlSize.new((base_unit.value / (12_700 * 100)).round(OoxmlParser.configuration.accuracy), output_unit)
+        OoxmlSize.new((base_unit.value / (12_700 * 100)).round(OoxmlParser.configuration.accuracy), output_unit)
       else
-        return base_unit
+        base_unit
       end
     end
   end

data/lib/ooxml_parser/common_parser/common_data/alternate_content/drawing/drawing_properties/size_relative/picture_dimension.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for parsing `wp14:pctWidth`, `wp14:pctHeight` object
   class PictureDimension < OOXMLDocumentObject

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'size_relative/picture_dimension'
 module OoxmlParser
   # Class for parsing `wp14:sizeRelH` object

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OoxmlParser
   # Class for parsing `wp14:sizeRelV` object
   class SizeRelativeVertical < OOXMLDocumentObject

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'shape/docx_shape'
 require_relative 'picture/docx_picture'
 module OoxmlParser
@@ -22,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
+          @data = Chart.parse(parent: self)
           OOXMLDocumentObject.xmls_stack.pop
         when 'wgp'
           @type = :group

data/lib/ooxml_parser/common_parser/common_data/alternate_content/drawing/graphic/picture/docx_blip.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'docx_blip/file_reference'
 module OoxmlParser
   # Class for parsing `blipFill`
@@ -8,6 +10,7 @@ module OoxmlParser
 
     alias path path_to_media_file
 
+    # @return [String] result of convert of object to string
     def to_str
       path_to_media_file
     end
@@ -18,6 +21,7 @@ module OoxmlParser
     def parse(node)
       blip_node = node.xpath('a:blip', 'xmlns:a' => 'http://schemas.openxmlformats.org/drawingml/2006/main').first
       return self if blip_node.nil?
+
       @file_reference = FileReference.new(parent: self).parse(blip_node)
       self
     end