ooxml_parser 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af046e45d945d773885e2c8c9c8becef406a7e0c50a1f71161e1252b73295441
-  data.tar.gz: 16e54721a7a8c6f066693343ad8950c88d136531b9f6a3a53d7d7154c199c699
+  metadata.gz: ee9d17ca1564f942a23f3ec27f80e47c92720dcc772f78ce9c05f5b4a083aab4
+  data.tar.gz: c7aacc7ac67a9e03aab11180a3d0815c985f10e99494e14ddb65dafc0996d722
 SHA512:
-  metadata.gz: 216969571d18f07e04e10c7499628dc59d131a531a7cf1f8abdaf390bba04f04912b5f4f3bc268cd06b45d4853eb9fe3347a1ef136cfa56f2e8f6b88fccde7ab
-  data.tar.gz: a14b99b7e06bfd36c38fe2e52774e617cc60f94193314b5bad6200fe5d973cc854a8774aa7a43bdcd556bfec6a2f53c0dee59ff978442f49663bd8e3c43a5d2d
+  metadata.gz: c9962f8a0a55810dcfe9fccf3f5915059eb1ea89343054fdaefbc835aa8bfdcbd6f492e1684e3944579b90196bf3cde395f34384411f3e8e27fcbb77a89d7e0a
+  data.tar.gz: c3422025469da1f6a10c385a0b7bb06d499aaa4e8f6c9c897f40b22a4caf0927288bcd9807e9e859b60f1017e5d31e00caba66dfc29b9d928dd156b5f471abd1

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

data/lib/ooxml_parser/common_parser/common_data/alternate_content/picture/shape/old_docx_shape_properties.rb

@@ -3,7 +3,7 @@
 module OoxmlParser
   # Fallback DOCX Shape Properties
   class OldDocxShapeProperties < OOXMLDocumentObject
-    attr_accessor :fill_color, :opacity, :stroke_color, :stroke_weight
+    attr_accessor :fill_color, :stroke_color, :stroke_weight
 
     # Parse OldDocxShapeProperties object
     # @param node [Nokogiri::XML:Element] node to parse
@@ -13,8 +13,6 @@ module OoxmlParser
         case key
         when 'fillcolor'
           @fill_color = Color.new(parent: self).parse_hex_string(value.value.delete('#'))
-        when 'opacity'
-          @opacity = value.value.to_f
         when 'strokecolor'
           @stroke_color = Color.new(parent: self).parse_hex_string(value.value.delete('#'))
         when 'strokeweight'

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

@@ -27,12 +27,15 @@ module OoxmlParser
       size.zero? && val == :none
     end
 
+    # @return [String] result of convert of object to string
     def to_s
       return '' if nil?
 
       "borders color: #{@color}, size: #{size}, space: #{@space}, value: #{@val}"
     end
 
+    # Method to copy object
+    # @return [BordersProperties] copied object
     def copy
       BordersProperties.new(@color, size, @val, @space)
     end

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

@@ -119,6 +119,7 @@ module OoxmlParser
       @parent = parent
     end
 
+    # @return [String] result of convert of object to string
     def to_s
       if @red == VALUE_FOR_NONE_COLOR && @green == VALUE_FOR_NONE_COLOR && @blue == VALUE_FOR_NONE_COLOR
         'none'
@@ -127,33 +128,43 @@ module OoxmlParser
       end
     end
 
+    # @return [String] inspect of object for debug means
     def inspect
       to_s
     end
 
+    # @return [String] color in hex value
     def to_hex
       (@red.to_s(16).rjust(2, '0') + @green.to_s(16).rjust(2, '0') + @blue.to_s(16).rjust(2, '0')).upcase
     end
 
     alias to_int16 to_hex
 
+    # @return [True, False] is color default
     def none?
       (@red == VALUE_FOR_NONE_COLOR) && (@green == VALUE_FOR_NONE_COLOR) && (@blue == VALUE_FOR_NONE_COLOR) ||
         (style == :nil)
     end
 
+    # @return [True, False] is color not default
     def any?
       !none?
     end
 
+    # @return [True, False] is color white
     def white?
       (@red == 255) && (@green == 255) && (@blue == 255)
     end
 
+    # Method to copy object
+    # @return [Color] copied object
     def copy
       Color.new(@red, @green, @blue)
     end
 
+    # Compare this object to other
+    # @param other [Object] any other object
+    # @return [True, False] result of comparision
     def ==(other)
       if other.is_a?(Color)
         if (@red == other.red) && (@green == other.green) && (@blue == other.blue)
@@ -190,18 +201,27 @@ module OoxmlParser
       (self.red - red).abs < delta && (self.green - green).abs < delta && (self.blue - blue).abs < delta ? true : false
     end
 
+    # Apply tint to color
+    # @param tint [Integer] tint to apply
+    # @return [void]
     def calculate_with_tint!(tint)
       @red += (tint.to_f * (255 - @red)).to_i
       @green += (tint.to_f * (255 - @green)).to_i
       @blue += (tint.to_f * (255 - @blue)).to_i
     end
 
+    # Apply shade to color
+    # @param shade [Integer] shade to apply
+    # @return [void]
     def calculate_with_shade!(shade)
       @red = (@red * shade.to_f).to_i
       @green = (@green * shade.to_f).to_i
       @blue = (@blue * shade.to_f).to_i
     end
 
+    # Parse color scheme data
+    # @param scheme_color_node [Nokogiri::XML:Element] node to parse
+    # @return [Color] result of parsing
     def parse_scheme_color(scheme_color_node)
       color = root_object.theme.color_scheme[scheme_color_node.attribute('val').value.to_sym].color
       hls = HSLColor.rgb_to_hsl(color)
@@ -229,6 +249,9 @@ module OoxmlParser
       self
     end
 
+    # Parse color model data
+    # @param color_model_parent_node [Nokogiri::XML:Element] node to parse
+    # @return [Color] result of parsing
     def parse_color_model(color_model_parent_node)
       color = nil
       tint = nil
@@ -240,9 +263,6 @@ module OoxmlParser
           end
         end
         case color_model_node.name
-        when 'scrgbClr'
-          color = Color.new(color_model_node.attribute('r').value.to_i, color_model_node.attribute('g').value.to_i, color_model_node.attribute('b').value.to_i)
-          color.alpha_channel = ColorAlphaChannel.parse(color_model_node)
         when 'srgbClr'
           color = Color.new.parse_hex_string(color_model_node.attribute('val').value)
           color.alpha_channel = ColorAlphaChannel.parse(color_model_node)
@@ -261,6 +281,9 @@ module OoxmlParser
       self
     end
 
+    # Parse color data
+    # @param color_node [Nokogiri::XML:Element] node to parse
+    # @return [Color] result of parsing
     def parse_color(color_node)
       case color_node.name
       when 'srgbClr'
@@ -280,6 +303,7 @@ module OoxmlParser
     end
 
     class << self
+      # @return [Color] random color
       def generate_random_color
         Color.new(rand(256), rand(256), rand(256))
       end
@@ -293,6 +317,8 @@ module OoxmlParser
         const_array_name.map { |current_color| Color.parse_string(current_color) }
       end
 
+      # @param index [Integer] index to get
+      # @return [Color] color by it's index
       def get_rgb_by_color_index(index)
         color_by_index = COLOR_INDEXED[index]
         return :unknown if color_by_index.nil?
@@ -300,12 +326,15 @@ module OoxmlParser
         color_by_index == 'n/a' ? Color.new : Color.new.parse_hex_string(color_by_index)
       end
 
+      # Parse color from string
+      # @param str [String] string to parse
+      # @return [Color] result of parsing
       def parse_string(str)
         return str if str.is_a?(Color)
         return Color.new(VALUE_FOR_NONE_COLOR, VALUE_FOR_NONE_COLOR, VALUE_FOR_NONE_COLOR) if str == 'none' || str == '' || str == 'transparent' || str.nil?
 
         split = if str.include?('RGB (') || str.include?('rgb(')
-                  str.gsub(/[(RGBrgb\(\) )]/, '').split(',')
+                  str.gsub(/[(RGBrgb() )]/, '').split(',')
                 elsif str.include?('RGB ') || str.include?('rgb')
                   str.gsub(/RGB |rgb/, '').split(', ')
                 else
@@ -317,6 +346,9 @@ module OoxmlParser
 
       alias parse parse_string
 
+      # Convert other object type to Color
+      # @param something [Object] object to convert
+      # @return [Color] result of conversion
       def to_color(something)
         case something
         when SchemeColor

data/lib/ooxml_parser/common_parser/common_data/color/ooxml_color.rb

@@ -18,6 +18,8 @@ module OoxmlParser
     # @return [Color] rgb color
     attr_reader :rgb
 
+    # Convert OoxmlColor to other color type
+    # @return [Object] result of conversion
     def to_color
       return Color.get_rgb_by_color_index(indexed) if indexed
       return ThemeColors.new(parent: self).parse_color_theme(theme, tint) if theme
@@ -26,6 +28,9 @@ module OoxmlParser
       value
     end
 
+    # Compare this object to other
+    # @param other [Object] any other object
+    # @return [True, False] result of comparision
     def ==(other)
       return to_color == other if other.is_a?(Color)
       return to_color == other if other.is_a?(Symbol)

data/lib/ooxml_parser/common_parser/common_data/colors/hsl_color.rb

@@ -19,6 +19,9 @@ module OoxmlParser
       @l = lightness
     end
 
+    # Convert rgb color to hsl
+    # @param rgb_color [Color] color to convert
+    # @return [HSLColor] result of convert
     def self.rgb_to_hsl(rgb_color)
       hls_color = HSLColor.new
       red = rgb_color.red.to_f # / 255.0
@@ -50,6 +53,7 @@ module OoxmlParser
     end
 
     # Chroma - The "colorfulness relative to the brightness of a similarly illuminated white".
+    # @return [Color] result
     def to_rgb
       chroma = (1 - (2 * @l - 1).abs) * @s
       x = chroma * (1 - ((@h / 60.0) % 2.0 - 1).abs)
@@ -73,6 +77,10 @@ module OoxmlParser
       Color.new(((rgb.red + m) * 255.0).round, ((rgb.green + m) * 255.0).round, ((rgb.blue + m) * 255.0).round)
     end
 
+    # Get lum value of color
+    # @param tint [Integer] tint to apply
+    # @param lum [Integer] lum without tint
+    # @return [Integer] result
     def calculate_lum_value(tint, lum)
       if tint.nil?
         lum
@@ -81,6 +89,9 @@ module OoxmlParser
       end
     end
 
+    # Convert to rgb with applied tint
+    # @param tint [Integer] tint to apply
+    # @return [Color] result of covert
     def calculate_rgb_with_tint(tint)
       self.l = calculate_lum_value(tint, @l * 255.0) / 255.0
       to_rgb