ooxml_parser 0.5.0 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc51b71e9f6946af4aebd3df5e9343a3f1a2ce016ca2d164c8f7a233dbfcbb17
-  data.tar.gz: b9e008e9e4bde76b5136ee2cb0841d3c74bad4fc493991128e534a4bf18401dd
+  metadata.gz: a6c4527d0b7792aa56cbbebb6bd824ae102ef05ebd34cf5c254d237b4db91649
+  data.tar.gz: 2ec7cc8db0789617c92def28654e0beac19cbc5197348cb440097a0e911a6542
 SHA512:
-  metadata.gz: 74b8eb6a6a4b61f77c5451617b640e2108c78f302ac2cfd8ee2332edfbb0085fcb5faee64b3417d3a9eb76f824d1fe6f841afa404328ceda6c584618db06a275
-  data.tar.gz: 373108844b1ba342fe75e053cdf14af096b974957523e470ce44b6d6f1f2b0a492581b18781557d789500edae1294f885c3ce8975606ad2dea98c8bc0a81c83e
+  metadata.gz: d5b906924c2cd8fdfb0c199d3de2070964875bd514bfa4090160e3aec18d712d6f5a91159c9a1961d7a76569ba04aef40baedcf5127f1315fc0e628ae50c73fe
+  data.tar.gz: 06eb55cf4eb895dc896721e796f97e12e973af1f27fde9e463fcc74ba8994ae6d8ffe3f7d03e64c0a72283a735e9e044f68fa0e93ee0808e0457cf6a67d40100

data/lib/ooxml_parser.rb

@@ -29,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/choice.rb

@@ -6,6 +6,7 @@ module OoxmlParser
   # 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

@@ -5,6 +5,7 @@ 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

@@ -4,6 +4,7 @@ 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

@@ -41,6 +41,9 @@ module OoxmlParser
       @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
@@ -71,6 +74,9 @@ module OoxmlParser
     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)

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

@@ -11,7 +11,7 @@ module OoxmlParser
     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
@@ -35,7 +35,7 @@ module OoxmlParser
         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'

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

@@ -20,6 +20,4 @@ module OoxmlParser
       self
     end
   end
-
-  Categories = SeriesText
 end

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

@@ -5,6 +5,9 @@ module OoxmlParser
   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/ooxml_coordinates.rb

@@ -18,6 +18,7 @@ module OoxmlParser
            end
     end
 
+    # @return [String] result of convert of object to string
     def to_s
       '(' + @x.to_s + '; ' + @y.to_s + ')'
     end

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

@@ -28,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
@@ -40,7 +43,7 @@ module OoxmlParser
     # @return [String] string representation of size
     def to_s(unit = :centimeter)
       converted = to_unit(unit)
-      "#{converted.value} #{converted.unit}"
+      "#{converted.value.to_f} #{converted.unit}"
     end
 
     # Convert all values to one same base unit

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

@@ -10,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

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

@@ -10,6 +10,9 @@ module OoxmlParser
     # @return [String] content of file
     attr_accessor :content
 
+    # Parse FileReference object
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [FileReference] result of parsing
     def parse(node)
       node.attributes.each do |key, value|
         case key
@@ -26,6 +29,7 @@ module OoxmlParser
         return self
       end
       return self if @path == 'NULL'
+      return self if @path.match?(URI::DEFAULT_PARSER.make_regexp)
 
       full_path_to_file = OOXMLDocumentObject.path_to_folder + OOXMLDocumentObject.root_subfolder + @path.gsub('..', '')
       if File.exist?(full_path_to_file)

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

@@ -28,6 +28,4 @@ module OoxmlParser
       self
     end
   end
-
-  Picture = DocxPicture
 end

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

@@ -2,6 +2,7 @@
 
 require_relative 'docx_shape/ooxml_text_box'
 require_relative 'docx_shape/non_visual_shape_properties'
+require_relative 'docx_shape/shape_style'
 require_relative 'docx_shape/text_body'
 require_relative 'shape_properties/docx_shape_properties'
 require_relative 'shape_body_properties/ooxml_shape_body_properties'
@@ -32,6 +33,8 @@ module OoxmlParser
           @non_visual_properties = NonVisualShapeProperties.new(parent: self).parse(node_child)
         when 'spPr'
           @properties = DocxShapeProperties.new(parent: self).parse(node_child)
+        when 'style'
+          @style = ShapeStyle.new(parent: self).parse(node_child)
         when 'txbx'
           @text_body = OOXMLTextBox.new(parent: self).parse(node_child)
         when 'txBody'

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

@@ -3,7 +3,7 @@
 module OoxmlParser
   # Class for parsing `txbx` tags
   class OOXMLTextBox < OOXMLDocumentObject
-    attr_accessor :properties, :elements
+    attr_accessor :elements
 
     def initialize(parent: nil)
       @elements = []
@@ -21,8 +21,6 @@ module OoxmlParser
           @elements << DocxParagraph.new(parent: self).parse(node_child, index)
         when 'tbl'
           @elements << Table.new(parent: self).parse(node_child, index)
-        when 'bodyPr'
-          @properties = OOXMLShapeBodyProperties.new(parent: self).parse(node_child)
         end
       end
       self

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative 'shape_style/effect_reference'
+require_relative 'shape_style/fill_reference'
+require_relative 'shape_style/font_reference'
+require_relative 'shape_style/line_reference'
+module OoxmlParser
+  # Class for parsing `wps:style` tags
+  class ShapeStyle < OOXMLDocumentObject
+    # @return [FillReference] effect reference
+    attr_reader :effect_reference
+    # @return [FillReference] fill reference
+    attr_reader :fill_reference
+    # @return [FontReference] font reference
+    attr_reader :font_reference
+    # @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
+    def parse(node)
+      node.xpath('*').each do |node_child|
+        case node_child.name
+        when 'effectRef'
+          @effect_reference = EffectReference.new(parent: self).parse(node_child)
+        when 'fillRef'
+          @fill_reference = FillReference.new(parent: self).parse(node_child)
+        when 'fontRef'
+          @font_reference = FontReference.new(parent: self).parse(node_child)
+        when 'lnRef'
+          @line_reference = LineReference.new(parent: self).parse(node_child)
+        end
+      end
+      self
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Class for parsing `a:effectRef` tags
+  class EffectReference < OOXMLDocumentObject
+    # @return [Integer] Style Matrix Index
+    attr_reader :index
+    # @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
+    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 'schemeClr'
+          @scheme_color = Color.new(parent: self).parse_scheme_color(node_child)
+        end
+      end
+      self
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Class for parsing `a:fillRef` tags
+  class FillReference < OOXMLDocumentObject
+    # @return [Integer] Style Matrix Index
+    attr_reader :index
+    # @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
+    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 'schemeClr'
+          @scheme_color = Color.new(parent: self).parse_scheme_color(node_child)
+        end
+      end
+      self
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Class for parsing `a:fontRef` tags
+  class FontReference < OOXMLDocumentObject
+    # @return [String] Font Collection Index
+    attr_reader :index
+    # @return [Color] scheme color of FontReference
+    attr_reader :scheme_color
+
+    def initialize(parent: nil)
+      @parent = parent
+    end
+
+    # Parse FontReference object
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [FontReference] result of parsing
+    def parse(node)
+      node.attributes.each do |key, value|
+        case key
+        when 'idx'
+          @index = value.value.to_s
+        end
+      end
+
+      node.xpath('*').each do |node_child|
+        case node_child.name
+        when 'schemeClr'
+          @scheme_color = Color.new(parent: self).parse_scheme_color(node_child)
+        end
+      end
+      self
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module OoxmlParser
+  # Class for parsing `a:lnRef` tags
+  class LineReference < OOXMLDocumentObject
+    # @return [Integer] Style Matrix Index
+    attr_reader :index
+    # @return [Color] scheme color of LineReference
+    attr_reader :scheme_color
+
+    def initialize(parent: nil)
+      @parent = parent
+    end
+
+    # Parse LineReference object
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [LineReference] 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 'schemeClr'
+          @scheme_color = Color.new(parent: self).parse_scheme_color(node_child)
+        end
+      end
+      self
+    end
+  end
+end

data/lib/ooxml_parser/common_parser/common_data/alternate_content/drawing/graphic/shape/shape_properties/color/docx_color_scheme.rb

@@ -35,6 +35,7 @@ module OoxmlParser
       self
     end
 
+    # @return [String] result of convert of object to string
     def to_s
       "Color: #{@color}, type: #{type}"
     end

data/lib/ooxml_parser/common_parser/common_data/alternate_content/drawing/graphic/shape/shape_properties/custom_geometry/docx_custom_geometry/docx_shape_line_path/docx_shape_line_element.rb

@@ -23,8 +23,6 @@ module OoxmlParser
         @type = :arc
       when 'cubicBezTo'
         @type = :cubic_bezier
-      when 'quadBezTo'
-        @type = :quadratic_bezier
       when 'close'
         @type = :close
       end

data/lib/ooxml_parser/common_parser/common_data/alternate_content/drawing/graphic/shape/shape_properties/docx_shape_line.rb

@@ -16,6 +16,7 @@ module OoxmlParser
       @parent = parent
     end
 
+    # @return [Integer] stroke size of object
     def stroke_size
       if @color_scheme.nil? || @color_scheme.color == :none
         0

data/lib/ooxml_parser/common_parser/common_data/alternate_content/drawing/graphic/shape/shape_properties/docx_shape_properties.rb

@@ -10,7 +10,7 @@ require_relative 'custom_geometry/ooxml_custom_geometry'
 module OoxmlParser
   # DOCX Shape Properties
   class DocxShapeProperties < OOXMLDocumentObject
-    attr_accessor :shape_size, :preset_geometry, :fill_color, :text_box, :line, :custom_geometry
+    attr_accessor :shape_size, :preset_geometry, :fill_color, :line, :custom_geometry
     attr_accessor :blip_fill
 
     alias transform shape_size
@@ -33,8 +33,6 @@ module OoxmlParser
           @shape_size = DocxShapeSize.new(parent: self).parse(node_child)
         when 'prstGeom'
           @preset_geometry = PresetGeometry.new(parent: self).parse(node_child)
-        when 'txbx'
-          @text_box = TextBox.parse_list(node_child)
         when 'ln'
           @line = DocxShapeLine.new(parent: self).parse(node_child)
         when 'blipFill'

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

@@ -6,7 +6,7 @@ require_relative 'group/old_docx_group'
 module OoxmlParser
   # Fallback DOCX Picture
   class OldDocxPicture < OOXMLDocumentObject
-    attr_accessor :data, :type, :style_number
+    attr_accessor :data, :type
 
     # Parse OldDocxPicture object
     # @param node [Nokogiri::XML:Element] node to parse
@@ -20,8 +20,6 @@ module OoxmlParser
         when 'group'
           @type = :group
           @data = OldDocxGroup.new(parent: self).parse(node_child)
-        when 'style'
-          @style_number = node_child.attribute('val').value.to_i
         end
       end
       self