ooxml_parser 0.5.0 → 0.7.2

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

@@ -93,12 +93,14 @@ module OoxmlParser
     attr_accessor :blue
     # @return [String] Value of Color Style
     attr_accessor :style
+
     alias set_style style=
     # @return [String] color scheme of color
     attr_accessor :scheme
 
     # @return [Integer] Value of alpha-channel
     attr_accessor :alpha_channel
+
     alias set_alpha_channel alpha_channel=
 
     attr_accessor :position
@@ -117,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'
@@ -125,38 +128,46 @@ 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 nil?
-          false
-        elsif (@red == other.red) && (@green == other.green) && (@blue == other.blue)
+        if (@red == other.red) && (@green == other.green) && (@blue == other.blue)
           true
         elsif (none? && other.white?) || (white? && other.none?)
           true
@@ -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

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

@@ -11,6 +11,7 @@ module OoxmlParser
       @parent = parent
     end
 
+    # @return [String] result of convert of object to string
     def to_s
       @converted_color.to_s
     end

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

@@ -6,6 +6,10 @@ module OoxmlParser
     # @return [Hash] list of colors
     attr_accessor :list
 
+    # Parse color theme
+    # @param theme [String] name of theme
+    # @param tint [Integer] tint of theme
+    # @return [Color] color of theme
     def parse_color_theme(theme, tint)
       themes_array = root_object.theme.color_scheme.values
       # TODO: if no swap performed - incorrect color parsing. But don't know why it needed

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

@@ -18,6 +18,8 @@ module OoxmlParser
       @content_types_list[key]
     end
 
+    # Parse ContentTypes object
+    # @return [ContentTypes] result of parsing
     def parse
       doc = Nokogiri::XML.parse(File.open("#{OOXMLDocumentObject.path_to_folder}/[Content_Types].xml"))
       node = doc.xpath('*').first

data/lib/ooxml_parser/common_parser/common_data/content_types/content_type_default.rb

@@ -8,6 +8,9 @@ module OoxmlParser
     # @return [String] extension
     attr_reader :extension
 
+    # Parse ContentTypeDefault object
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [ContentTypeDefault] result of parsing
     def parse(node)
       node.attributes.each do |key, value|
         case key

data/lib/ooxml_parser/common_parser/common_data/content_types/content_type_override.rb

@@ -8,6 +8,9 @@ module OoxmlParser
     # @return [String] part name
     attr_reader :part_name
 
+    # Parse ContentTypeOverride object
+    # @param node [Nokogiri::XML:Element] node to parse
+    # @return [ContentTypeOverride] result of parsing
     def parse(node)
       node.attributes.each do |key, value|
         case key

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

@@ -29,6 +29,9 @@ module OoxmlParser
         coordinates
       end
 
+      # Parse range of coordinates
+      # @param arguments_string [String] data to parse
+      # @return [Array] result
       def parser_coordinates_range(arguments_string)
         return parse_coordinates_array(arguments_string) if arguments_string.include?(',')
         return warn "Formulas with # is unsupported: #{arguments_string}" if arguments_string.include?('#')
@@ -133,6 +136,7 @@ module OoxmlParser
       column_number > other_cell.column_number
     end
 
+    # @return [String] result of convert of object to string
     def to_s
       "#{@column}#{@row} #{@list ? "list: #{@list}" : ''}"
     end
@@ -141,6 +145,9 @@ module OoxmlParser
       @column.nil? && @list.nil? && @row.nil?
     end
 
+    # Compare this object to other
+    # @param other [Object] any other object
+    # @return [True, False] result of comparision
     def ==(other)
       other.is_a?(Coordinates) ? (@row == other.row && @column == other.column) : false
     end

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

@@ -19,7 +19,12 @@ module OoxmlParser
       @parent = parent
     end
 
+    # Compare this object to other
+    # @param other [Object] any other object
+    # @return [True, False] result of comparision
     def ==(other)
+      return false if self.class != other.class
+
       instance_variables.each do |current_attribute|
         next if current_attribute == :@parent
         return false unless instance_variable_get(current_attribute) == other.instance_variable_get(current_attribute)
@@ -44,9 +49,11 @@ module OoxmlParser
       attr_accessor :path_to_folder
 
       # @param path_to_file [String] file
+      # @param ignore_system [True, False] should host system be ignored, since
+      #   this method is OS-dependent
       # @return [True, False] Check if file is protected by password on open
-      def encrypted_file?(path_to_file)
-        if Gem.win_platform?
+      def encrypted_file?(path_to_file, ignore_system: false)
+        if Gem.win_platform? || ignore_system
           warn 'FileMagic and checking file for encryption is not supported on Windows'
           return false
         end
@@ -63,6 +70,9 @@ module OoxmlParser
         false
       end
 
+      # Copy this file and rename to zip
+      # @param path [String] path to file
+      # @return [String] path to result zip
       def copy_file_and_rename_to_zip(path)
         file_name = File.basename(path)
         tmp_folder = Dir.mktmpdir('ruby-ooxml-parser')
@@ -75,6 +85,10 @@ module OoxmlParser
         file_path
       end
 
+      # Unzip specified file
+      # @param path_to_file [String] path to zip file
+      # @param destination [String] folder to extract
+      # @return [void]
       def unzip_file(path_to_file, destination)
         Zip.warn_invalid_date = false
         Zip::File.open(path_to_file) do |zip_file|
@@ -88,14 +102,19 @@ module OoxmlParser
         end
       end
 
+      # @return [String] dir to base of file
       def dir
         OOXMLDocumentObject.path_to_folder + File.dirname(OOXMLDocumentObject.xmls_stack.last) + '/'
       end
 
+      # @return [String] path to current xml file
       def current_xml
         OOXMLDocumentObject.path_to_folder + OOXMLDocumentObject.xmls_stack.last
       end
 
+      # Add file to parsing stack
+      # @param path [String] path of file to add to stack
+      # @return [void]
       def add_to_xmls_stack(path)
         OOXMLDocumentObject.xmls_stack << if path.include?('..')
                                             "#{File.dirname(OOXMLDocumentObject.xmls_stack.last)}/#{path}"
@@ -106,6 +125,9 @@ module OoxmlParser
                                           end
       end
 
+      # Get link to file from rels file
+      # @param id [String] file to get
+      # @return [String] result
       def get_link_from_rels(id)
         rels_path = dir + "_rels/#{File.basename(OOXMLDocumentObject.xmls_stack.last)}.rels"
         raise LoadError, "Cannot find .rels file by path: #{rels_path}" unless File.exist?(rels_path)

data/lib/ooxml_parser/common_parser/common_data/paragraph/paragraph_run.rb

@@ -40,14 +40,17 @@ module OoxmlParser
       text.empty?
     end
 
+    # @return [String] instruction applied to paragraph
     def instruction
       parent.instruction
     end
 
+    # @return [True, False] is page number applyed
     def page_number
       parent.page_numbering?
     end
 
+    # @return [Hyperlink] link of run
     def link
       parent.parent.hyperlink
     end

data/lib/ooxml_parser/common_parser/common_data/paragraph/paragraph_run/run_properties.rb

@@ -29,10 +29,6 @@ module OoxmlParser
     attr_accessor :shade
     # @return [RunStyle] run style
     attr_accessor :run_style
-    # @return [Float]
-    # This element specifies the font size which shall be applied to all
-    # complex script characters in the contents of this run when displayed
-    attr_accessor :font_size_complex
 
     def initialize(parent: nil)
       @font_name = ''
@@ -50,8 +46,6 @@ module OoxmlParser
         case key
         when 'sz'
           @font_size = value.value.to_f / 100.0
-        when 'szCs'
-          @font_size_complex = node.attribute('val').value.to_i / 2.0
         when 'spc'
           @space = OoxmlSize.new(value.value.to_f, :one_100th_point)
         when 'b'