ooxml_parser 0.5.1 → 0.8.0

data/lib/ooxml_parser/common_parser/common_data/color/color_indexes.list

@@ -0,0 +1,66 @@
+000000
+FFFFFF
+FF0000
+00FF00
+0000FF
+FFFF00
+FF00FF
+00FFFF
+000000
+FFFFFF
+FF0000
+00FF00
+0000FF
+FFFF00
+FF00FF
+00FFFF
+800000
+008000
+000080
+808000
+800080
+008080
+C0C0C0
+808080
+9999FF
+993366
+FFFFCC
+CCFFFF
+660066
+FF8080
+0066CC
+CCCCFF
+000080
+FF00FF
+FFFF00
+00FFFF
+800080
+800000
+008080
+0000FF
+00CCFF
+CCFFFF
+CCFFCC
+FFFF99
+99CCFF
+FF99CC
+CC99FF
+FFCC99
+3366FF
+33CCCC
+99CC00
+FFCC00
+FF9900
+FF6600
+666699
+969696
+003366
+339966
+003300
+333300
+993300
+993366
+333399
+333333
+n/a
+n/a

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

@@ -3,8 +3,14 @@
 module OoxmlParser
   # Class for color transformations
   class ColorProperties < OOXMLDocumentObject
-    attr_accessor :alpha, :luminance_modulation, :luminance_offset
-    attr_accessor :tint
+    # @return [Integer] alpha value of color
+    attr_reader :alpha
+    # @return [Float] luminance modulation value
+    attr_reader :luminance_modulation
+    # @return [Float] luminance offset value
+    attr_reader :luminance_offset
+    # @return [Float] tint value
+    attr_reader :tint
 
     # Parse ColorProperties object
     # @param node [Nokogiri::XML:Element] node to parse

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

@@ -3,9 +3,20 @@
 module OoxmlParser
   # Class for parsing `hlinkClick`, `hyperlink` tags
   class Hyperlink < OOXMLDocumentObject
-    attr_accessor :url, :tooltip, :coordinates, :highlight_click, :action
-    attr_accessor :action_link
-    attr_accessor :id
+    # @return [OOXMLDocumentObject] url of hyperlink
+    attr_accessor :url
+    # @return [String] tooltip value
+    attr_reader :tooltip
+    # @return [Coordinates] coordinates of link
+    attr_reader :coordinates
+    # @return [True, False] should click be highlighted
+    attr_reader :highlight_click
+    # @return [Symbol] type of action
+    attr_reader :action
+    # @return [String] value of action link
+    attr_reader :action_link
+    # @return [String] id of link
+    attr_reader :id
     # @return [Array<ParagraphRun>] run of paragraph
     attr_reader :runs
 

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)
@@ -38,15 +43,21 @@ module OoxmlParser
     end
 
     class << self
+      # @return [String] path to root subfolder
       attr_accessor :root_subfolder
+      # @return [PresentationTheme] list of themes
       attr_accessor :theme
+      # @return [Array<String>] stack of xmls
       attr_accessor :xmls_stack
+      # @return [String] path to root folder
       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 +74,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 +89,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 +106,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 +129,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

@@ -9,12 +9,34 @@ require_relative 'run_properties/shade'
 module OoxmlParser
   # Data about `rPr` object
   class RunProperties < OOXMLDocumentObject
-    attr_accessor :font_style, :font_color, :space, :dirty, :font_name, :font_size, :baseline, :hyperlink, :caps,
-                  :vertical_align, :outline
-    attr_accessor :shadow
-    attr_accessor :emboss
-    attr_accessor :vanish
-    attr_accessor :rtl
+    # @return [FontStyle] font style of run
+    attr_accessor :font_style
+    # @return [Color, DocxColorScheme] color of run
+    attr_reader :font_color
+    # @return [OoxmlSize] space size
+    attr_reader :space
+    # @return [string] name of font
+    attr_reader :font_name
+    # @return [Float] font size
+    attr_reader :font_size
+    # @return [Symbol] baseline of run
+    attr_reader :baseline
+    # @return [Hyperlink] hyperlink of run
+    attr_reader :hyperlink
+    # @return [Symbol] caps data
+    attr_reader :caps
+    # @return [Symbol] vertical align data
+    attr_reader :vertical_align
+    # @return [Outline] outline data
+    attr_reader :outline
+    # @return [True, False] is text shadow
+    attr_reader :shadow
+    # @return [True, False] is text emboss
+    attr_reader :emboss
+    # @return [True, False] is text vanish
+    attr_reader :vanish
+    # @return [True, False] is text rtl
+    attr_reader :rtl
     # @return [Size] get run size
     attr_accessor :size
     # @return [RunSpacing] get run spacing
@@ -29,10 +51,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 +68,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'

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

@@ -4,8 +4,10 @@
 module OoxmlParser
   # Class for parsing `w:ln` tags
   class Outline < OOXMLDocumentObject
-    attr_accessor :width
-    attr_accessor :color_scheme
+    # @return [OoxmlSize] width of outline
+    attr_reader :width
+    # @return [DocxColorScheme] color of outline
+    attr_reader :color_scheme
 
     def initialize(parent: nil)
       @width = OoxmlSize.new(0)

data/lib/ooxml_parser/common_parser/common_data/paragraph/paragrpah_properties/numbering_properties.rb

@@ -10,6 +10,7 @@ module OoxmlParser
       @parent = parent
     end
 
+    # @return [AbstractNumbering] AbstractNumbering of current properties
     def abstruct_numbering
       root_object.numbering.properties_by_num_id(@numbering_properties)
     end
@@ -29,6 +30,7 @@ module OoxmlParser
       self
     end
 
+    # @return [AbstractNumbering] level list of current numbering
     def numbering_level_current
       abstruct_numbering.level_list.each do |current_ilvl|
         return current_ilvl if current_ilvl.ilvl == @ilvl

data/lib/ooxml_parser/common_parser/common_data/paragraph/paragrpah_properties/paragraph_borders.rb

@@ -16,6 +16,7 @@ module OoxmlParser
     # @return [BordersProperties] bar properties
     attr_accessor :bar
 
+    # @return [Symbol] type of border in visual editor
     def border_visual_type
       result = []
       result << :left if @left.val == :single