ooxml_parser 0.5.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 707812f11e8f53f5f19473a465a41a4b91a5e01792eb6c32463199930e5efb10
-  data.tar.gz: b37d6875b9f5fded50a7ab16a81b50243d9f6533d23744fd27c865f148b7a3b3
+  metadata.gz: bff9ef732546243f5b751041e9fb41602a4e0ca823f93a83f671975e881cf6fd
+  data.tar.gz: 3e5bc500fb572b0fa43297f6d85a0f47e1d35365caed9803441b81785808e83d
 SHA512:
-  metadata.gz: dcc58ccf69813588db3a3d1a7d8606d8e433c7754c7854a72e98fd3e75e24aa52567ccd3a10b98668b20357eee584ae2182bcfea8aa4159ba1d13da2f0fb8eee
-  data.tar.gz: f4ce9b755786df2a9f9f1c6ba8d986660d875c8f5539486e7898be8512b2e69666c0908a3cfefa7ecd62e9285883ac6e897df6edc79fa42198dbb056d48f1e0c
+  metadata.gz: 93a6648cf7f5ce6a088d3c654c2c50b04afb363507e20ef8f2198ba35265310dfc44205819b32d635b997c589656bb87514fc5ab2007d2b898accf4d8fcb2b4b
+  data.tar.gz: 3e3f6e9c0a70516a176f5614294f8aecb02be45219c9a9c6799d3b3e75e7a2d7b6ff0a3680e6a8f18d8bbd6d8658740cac1157447b94659bd082a07ec9025a5e

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/docx_drawing.rb

@@ -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_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/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/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